forked from enlightenment/efl
docs: Clarify event emission in Image.Gfx.Image_Load_Controller
And minor formatting.
This commit is contained in:
parent
b0c3062e24
commit
22f3cc0574
|
@ -21,8 +21,8 @@ interface @beta Efl.Gfx.Image_Load_Controller
|
|||
load_async_start {
|
||||
[[Begin preloading an image object's image data in the background.
|
||||
|
||||
Once the background task is complete the event $load,done will be
|
||||
emitted.
|
||||
Once the background task is complete the event @[.load,done] will be
|
||||
emitted if loading succeeded, @[.load,error] otherwise.
|
||||
]]
|
||||
}
|
||||
load_async_cancel {
|
||||
|
@ -51,9 +51,9 @@ interface @beta Efl.Gfx.Image_Load_Controller
|
|||
|
||||
The image will be loaded into memory as if it was the specified
|
||||
size instead of its original size. This can save a lot of memory
|
||||
and is important for scalable types like svg.
|
||||
and is important for scalable types like SVG.
|
||||
|
||||
By default, the load size is not specified, so it is 0x0.
|
||||
By default, the load size is not specified, so it is $[0x0].
|
||||
]]
|
||||
set {
|
||||
[[Requests the canvas to load the image at the given size.
|
||||
|
@ -89,7 +89,7 @@ interface @beta Efl.Gfx.Image_Load_Controller
|
|||
]]
|
||||
get {}
|
||||
values {
|
||||
support: bool; [[$true if region load of the image is supported, $false otherwise]]
|
||||
support: bool; [[$true if region load of the image is supported, $false otherwise.]]
|
||||
}
|
||||
}
|
||||
@property load_region {
|
||||
|
@ -101,7 +101,7 @@ interface @beta Efl.Gfx.Image_Load_Controller
|
|||
|
||||
Note: The image loader for the image format in question has
|
||||
to support selective region loading in order for this function
|
||||
to work.
|
||||
to work (see @.load_region_support).
|
||||
]]
|
||||
set {
|
||||
}
|
||||
|
@ -137,7 +137,7 @@ interface @beta Efl.Gfx.Image_Load_Controller
|
|||
image. Most useful for the SVG image loader but also applies
|
||||
to JPEG, PNG and BMP.
|
||||
|
||||
Powers of two (2, 4, 8) are best supported (especially with JPEG)
|
||||
Powers of two (2, 4, 8, ...) are best supported (especially with JPEG).
|
||||
]]
|
||||
set {
|
||||
[[Requests the image loader to scale down by $div times.
|
||||
|
@ -152,7 +152,7 @@ interface @beta Efl.Gfx.Image_Load_Controller
|
|||
@property load_skip_header {
|
||||
[[Initial load should skip header check and leave it all to data load.
|
||||
|
||||
If this is true, then future loads of images will defer header
|
||||
If this is $true, then future loads of images will defer header
|
||||
loading to a preload stage and/or data load later on rather than
|
||||
at the start when the load begins (e.g. when file is set).
|
||||
]]
|
||||
|
@ -160,12 +160,12 @@ interface @beta Efl.Gfx.Image_Load_Controller
|
|||
}
|
||||
get {}
|
||||
values {
|
||||
skip: bool; [[Will be true if header is to be skipped. ]]
|
||||
skip: bool; [[$true if header is to be skipped.]]
|
||||
}
|
||||
}
|
||||
}
|
||||
events {
|
||||
load,done: void; [[Called when he image was loaded]]
|
||||
load,error: Eina.Error; [[Called when an error happened during image loading]]
|
||||
load,done: void; [[Emitted after the image has been loaded.]]
|
||||
load,error: Eina.Error; [[Emitted if an error happened during image loading.]]
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue