~~Title: Efl.Canvas.Scene~~
====== Efl.Canvas.Scene (interface) ======

===== Description =====

%%Interface containing basic canvas-related methods and events.%%

//Since 1.22//

{{page>:develop:api-include:efl:canvas:scene:description&nouser&nolink&nodate}}

===== Members =====

**[[:develop:api:efl:canvas:scene:property:device|device]]** //**(get)**//\\
> %%Get a device by name.%%
<code c>
Efl_Input_Device *efl_canvas_scene_device_get(const Eo *obj, const char *name);
</code>
\\
**[[:develop:api:efl:canvas:scene:method:group_objects_calculate|group_objects_calculate]]**\\
> %%Call user-provided %%''calculate''%% group functions and unset the flag signalling that the object needs to get recalculated to all group objects in the canvas.%%
<code c>
void efl_canvas_scene_group_objects_calculate(Eo *obj);
</code>
\\
**[[:develop:api:efl:canvas:scene:property:group_objects_calculating|group_objects_calculating]]** //**(get)**//\\
> 
<code c>
Eina_Bool efl_canvas_scene_group_objects_calculating_get(const Eo *obj);
</code>
\\
**[[:develop:api:efl:canvas:scene:property:image_max_size|image_max_size]]** //**(get)**//\\
> 
<code c>
Eina_Bool efl_canvas_scene_image_max_size_get(const Eo *obj, Eina_Size2D *max);
</code>
\\
**[[:develop:api:efl:canvas:scene:method:object_top_at_xy_get|object_top_at_xy_get]]**\\
> %%Retrieve the object stacked at the top of a given position in a canvas.%%
<code c>
Efl_Gfx_Entity *efl_canvas_scene_object_top_at_xy_get(const Eo *obj, Eina_Position2D pos, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects);
</code>
\\
**[[:develop:api:efl:canvas:scene:method:object_top_in_rectangle_get|object_top_in_rectangle_get]]**\\
> %%Retrieve the canvas object stacked at the top of a given rectangular region in a canvas%%
<code c>
Efl_Gfx_Entity *efl_canvas_scene_object_top_in_rectangle_get(const Eo *obj, Eina_Rect rect, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects);
</code>
\\
**[[:develop:api:efl:canvas:scene:method:objects_at_xy_get|objects_at_xy_get]]**\\
> %%Retrieve a list of objects at a given position in a canvas.%%
<code c>
Eina_Iterator *efl_canvas_scene_objects_at_xy_get(Eo *obj, Eina_Position2D pos, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects);
</code>
\\
**[[:develop:api:efl:canvas:scene:method:objects_in_rectangle_get|objects_in_rectangle_get]]**\\
> %%Retrieve a list of objects overlapping a given rectangular region in a canvas.%%
<code c>
Eina_Iterator *efl_canvas_scene_objects_in_rectangle_get(Eo *obj, Eina_Rect rect, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects);
</code>
\\
**[[:develop:api:efl:canvas:scene:property:pointer_position|pointer_position]]** //**(get)**//\\
> 
<code c>
Eina_Bool efl_canvas_scene_pointer_position_get(const Eo *obj, Efl_Input_Device *seat, Eina_Position2D *pos);
</code>
\\
**[[:develop:api:efl:canvas:scene:property:seat|seat]]** //**(get)**//\\
> %%Get a seat by id.%%
<code c>
Efl_Input_Device *efl_canvas_scene_seat_get(const Eo *obj, int id);
</code>
\\
**[[:develop:api:efl:canvas:scene:property:seat_default|seat_default]]** //**(get)**//\\
> %%Get the default seat.%%
<code c>
Efl_Input_Device *efl_canvas_scene_seat_default_get(const Eo *obj);
</code>
\\
**[[:develop:api:efl:canvas:scene:method:seats|seats]]**\\
> %%Iterate over the available input device seats for the canvas.%%
<code c>
Eina_Iterator *efl_canvas_scene_seats(Eo *obj);
</code>
\\

===== Events =====

**[[:develop:api:efl:canvas:scene:event:device_added|device,added]]**\\
> %%Called when input device was added%%
<code c>
EFL_CANVAS_SCENE_EVENT_DEVICE_ADDED(Efl_Input_Device *, @beta)
</code>
\\ **[[:develop:api:efl:canvas:scene:event:device_changed|device,changed]]**\\
> %%Called when input device changed%%
<code c>
EFL_CANVAS_SCENE_EVENT_DEVICE_CHANGED(Efl_Input_Device *, @beta)
</code>
\\ **[[:develop:api:efl:canvas:scene:event:device_removed|device,removed]]**\\
> %%Called when input device was removed%%
<code c>
EFL_CANVAS_SCENE_EVENT_DEVICE_REMOVED(Efl_Input_Device *, @beta)
</code>
\\ **[[:develop:api:efl:canvas:scene:event:object_focus_in|object,focus,in]]**\\
> %%Called when object got focus%%
<code c>
EFL_CANVAS_SCENE_EVENT_OBJECT_FOCUS_IN(Efl_Input_Focus *)
</code>
\\ **[[:develop:api:efl:canvas:scene:event:object_focus_out|object,focus,out]]**\\
> %%Called when object lost focus%%
<code c>
EFL_CANVAS_SCENE_EVENT_OBJECT_FOCUS_OUT(Efl_Input_Focus *)
</code>
\\ **[[:develop:api:efl:canvas:scene:event:render_post|render,post]]**\\
> %%Called when post render happens%%
<code c>
EFL_CANVAS_SCENE_EVENT_RENDER_POST(Efl_Gfx_Event_Render_Post, @beta)
</code>
\\ **[[:develop:api:efl:canvas:scene:event:render_pre|render,pre]]**\\
> %%Called when pre render happens%%
<code c>
EFL_CANVAS_SCENE_EVENT_RENDER_PRE(void)
</code>
\\ **[[:develop:api:efl:canvas:scene:event:scene_focus_in|scene,focus,in]]**\\
> %%Called when scene got focus%%
<code c>
EFL_CANVAS_SCENE_EVENT_SCENE_FOCUS_IN(void)
</code>
\\ **[[:develop:api:efl:canvas:scene:event:scene_focus_out|scene,focus,out]]**\\
> %%Called when scene lost focus%%
<code c>
EFL_CANVAS_SCENE_EVENT_SCENE_FOCUS_OUT(void)
</code>
\\