dimmus
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

mapbuf: convert docs

This commit is contained in:
Daniel Kolesa 2015-08-05 12:01:44 +01:00
parent 8859053a0a
commit 8b4fab0196
1 changed files with 68 additions and 116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

184
legacy/elementary/src/lib/elm_mapbuf.eo
View File

@ -4,172 +4,124 @@ class Elm.Mapbuf (Elm.Container)
methods { methods {
@property auto { @property auto {
set { set {
/*@ [[Set or unset auto flag for map rendering.
Set or unset auto flag for map rendering.
When a ampbuf object has "auto mode" enabled, then it will enable and When a ampbuf object has "auto mode" enabled, then it will
disable map mode based on current visibility. Mapbuf will track if you show enable and disable map mode based on current visibility.
or hide it AND if the object is inside the canvas viewport or not when it Mapbuf will track if you show or hide it AND if the object
is moved or resized. Note that if you turn automode off, then map mode is inside the canvas viewport or not when it is moved or
will be in a disabled state at this point. When you turn it on for the resized. Note that if you turn automode off, then map mode
first time, the current state will be evaluated base on current properties will be in a disabled state at this point. When you turn it
of the mapbuf object. on for the first time, the current state will be evaluated
base on current properties of the mapbuf object.
Auto mode is disabled by default. Auto mode is disabled by default.
]]
@ingroup Mapbuf */
} }
get { get {
/*@ [[Get a value whether auto mode is enabled or not.]]
Get a value whether auto mode is enabled or not.
@return @c EINA_TRUE means autso mode is enabled. @c EINA_FALSE
indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
@see elm_mapbuf_auto_set() for details.
@ingroup Mapbuf */
} }
values { values {
on: bool; /*@ @c EINA_TRUE to enable auto mode or @c EINA_FALSE on: bool; [[The auto mode state.]]
to disable it. */
} }
} }
@property smooth { @property smooth {
set { set {
/*@ [[Enable or disable smooth map rendering.
Enable or disable smooth map rendering.
This sets smoothing for map rendering. If the object is a type that has This sets smoothing for map rendering. If the object is a
its own smoothing settings, then both the smooth settings for this object type that has its own smoothing settings, then both the
and the map must be turned off. smooth settings for this object and the map must be turned off.
By default smooth maps are enabled. By default smooth maps are enabled.
]]
@ingroup Mapbuf */
} }
get { get {
/*@ [[Get a value whether smooth map rendering is enabled or not.]]
Get a value whether smooth map rendering is enabled or not.
@return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
@see elm_mapbuf_smooth_set() for details.
@ingroup Mapbuf */
} }
values { values {
smooth: bool; /*@ @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE smooth: bool; [[The smooth mode state.]]
to disable it. */
} }
} }
@property alpha { @property alpha {
set { set {
/*@ [[Set or unset alpha flag for map rendering.
Set or unset alpha flag for map rendering.
This sets alpha flag for map rendering. If the object is a type that has This sets alpha flag for map rendering. If the object is a
its own alpha settings, then this will take precedence. Only image objects type that has its own alpha settings, then this will take
have this currently. It stops alpha blending of the map area, and is precedence. Only image objects have this currently. It stops
useful if you know the object and/or all sub-objects is 100% solid. alpha blending of the map area, and is useful if you know the
object and/or all sub-objects is 100% solid.
Alpha is enabled by default. Alpha is enabled by default.
]]
@ingroup Mapbuf */
} }
get { get {
/*@ [[Get a value whether alpha blending is enabled or not.]]
Get a value whether alpha blending is enabled or not.
@return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
@see elm_mapbuf_alpha_set() for details.
@ingroup Mapbuf */
} }
values { values {
alpha: bool; /*@ @c EINA_TRUE to enable alpha blending or @c EINA_FALSE alpha: bool; [[The alpha state.]]
to disable it. */
} }
} }
@property enabled { @property enabled {
set { set {
/*@ [[Enable or disable the map.
Enable or disable the map.
This enables the map that is set or disables it. On enable, the object This enables the map that is set or disables it. On enable,
geometry will be saved, and the new geometry will change (position and the object geometry will be saved, and the new geometry will
size) to reflect the map geometry set. change (position and size) to reflect the map geometry set.
Also, when enabled, alpha and smooth states will be used, so if the Also, when enabled, alpha and smooth states will be used, so
content isn't solid, alpha should be enabled, for example, otherwise if the content isn't solid, alpha should be enabled, for
a black rectangle will fill the content. example, otherwise a black rectangle will fill the content.
When disabled, the stored map will be freed and geometry prior to When disabled, the stored map will be freed and geometry prior
enabling the map will be restored. to enabling the map will be restored.
It's disabled by default. It's disabled by default.
]]
@see elm_mapbuf_alpha_set()
@see elm_mapbuf_smooth_set()
@ingroup Mapbuf */
} }
get { get {
/*@ [[Get a value whether map is enabled or not.]]
Get a value whether map is enabled or not.
@return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
@see elm_mapbuf_enabled_set() for details.
@ingroup Mapbuf */
} }
values { values {
enabled: bool; /*@ @c EINA_TRUE to enable map or @c EINA_FALSE to disable it. */ enabled: bool; [[The enabled state.]]
} }
} }
point_color_set { point_color_set {
/*@ [[Set the color of a vertex in the mapbuf
Set the color of a vertex in the mapbuf
This sets the color of the vertex in the mapbuf. Colors will be linearly This sets the color of the vertex in the mapbuf. Colors will be
interpolated between vertex points through the mapbuf. Color will multiply linearly interpolated between vertex points through the mapbuf.
the "texture" pixels (like GL_MODULATE in OpenGL). The default color of Color will multiply the "texture" pixels (like GL_MODULATE in
a vertex in a mapbuf is white solid (255, 255, 255, 255) which means it will OpenGL). The default color of a vertex in a mapbuf is white
have no affect on modifying the texture pixels. solid (255, 255, 255, 255) which means it will have no affect
on modifying the texture pixels.
@see evas_object_map_set()
@since 1.9 */
@since 1.9
]]
params { params {
@in idx: int; /*@ index of point to change. Must be smaller than mapbuf size. */ @in idx: int; [[Index of point to change. Must be smaller than mapbuf size.]]
@in r: int; /*@ red (0 - 255) */ @in r: int; [[Red (0 - 255)]]
@in g: int; /*@ green (0 - 255) */ @in g: int; [[Green (0 - 255)]]
@in b: int; /*@ blue (0 - 255) */ @in b: int; [[Blue (0 - 255)]]
@in a: int; /*@ alpha (0 - 255) */ @in a: int; [[Alpha (0 - 255)]]
} }
} }
point_color_get { point_color_get {
/*@ [[Get the color set on a vertex in the mapbuf
Get the color set on a vertex in the mapbuf
This gets the color set by elm_mapbuf_point_color_set() on the given vertex This gets the color set by @.point_color_set on the given vertex
of the mapbuf. of the mapbuf.
@see elm_mapbuf_point_color_set()
@since 1.9 */
@since 1.9
]]
params { params {
@in idx: int; /*@ index of point get. Must be smaller than map size. */ @in idx: int; [[Index of point get. Must be smaller than map size.]]
@out r: int; /*@ pointer to red return */ @out r: int; [[Pointer to red return.]]
@out g: int; /*@ pointer to green return */ @out g: int; [[Pointer to green return.]]
@out b: int; /*@ pointer to blue return */ @out b: int; [[Pointer to blue return.]]
@out a: int; /*@ pointer to alpha return */ @out a: int; [[Pointer to alpha return.]]
} }
} }
} }