import"scenejs.idl";
|
| DOMString | get_option (DOMString section, DOMString key) |
| |
| *DOMString | get_option (DOMString section, unsigned key_idx) |
| |
| void | set_option (DOMString section, DOMString key, optional DOMString value=null) |
| |
| void | set_size (unsigned long width, unsigned long height) |
| |
| void | exit () |
| |
| void | set_3d (Boolean use_3d) |
| |
| void | move_window (unsigned long x, unsigned long y, optional boolean relative=false) |
| |
| void | set_event_filter (GPACEventFilter filter_event_func) |
| |
| void | set_focus (DOMString focus) |
| |
| void | set_focus (Node elt) |
| |
| void | show_keyboard (boolean do_show) |
| |
| void | trigger_gc () |
| |
| MediaObject | get_object_manager (DOMString url) |
| |
| void | switch_quality (boolean up) |
| |
| boolean | navigation_supported (unsigned long nav_type) |
| |
| void | set_back_color (double r, double g, double b, double a) |
| |
JSScene is the interface to compositor
◆ get_option() [1/2]
| DOMString JSScene::get_option |
( |
DOMString |
section, |
|
|
DOMString |
key |
|
) |
| |
see gf_opts_get_key
- Parameters
-
| section | the section name |
| key | the key name |
- Returns
- the key value
◆ get_option() [2/2]
| * DOMString JSScene::get_option |
( |
DOMString |
section, |
|
|
unsigned |
key_idx |
|
) |
| |
see gf_opts_get_key_name
- Parameters
-
| section | the section name |
| key_idx | the key index in the section |
- Returns
- the key name
◆ set_option()
| void JSScene::set_option |
( |
DOMString |
section, |
|
|
DOMString |
key, |
|
|
optional DOMString |
value = null |
|
) |
| |
see gf_opts_set_key
- Parameters
-
| section | the section name |
| key | the key name |
| value | the key value, null to remove the key |
◆ set_size()
| void JSScene::set_size |
( |
unsigned long |
width, |
|
|
unsigned long |
height |
|
) |
| |
set output window size
- Parameters
-
| width | desired width |
| height | desired height |
◆ exit()
◆ set_3d()
| void JSScene::set_3d |
( |
Boolean |
use_3d | ) |
|
turns 3D rendering on/off
- Parameters
-
| use_3d | if true, uses 3D for all content, otherwise use 3D based on content type |
◆ move_window()
| void JSScene::move_window |
( |
unsigned long |
x, |
|
|
unsigned long |
y, |
|
|
optional boolean |
relative = false |
|
) |
| |
moves output window
- Parameters
-
| x | the horizontal position or delta |
| y | the vertical position or delta |
| relative | if true, use relative (delta) positioning; otherwise use absolute |
◆ set_event_filter()
assigns event filter
- Parameters
-
| filter_event_func | the filter event function to use, or null to deactivate event filtering |
◆ set_focus() [1/2]
| void JSScene::set_focus |
( |
DOMString |
focus | ) |
|
moves focus
- Parameters
-
| focus | "next" for next element in focus ring, "prev" for previous |
◆ set_focus() [2/2]
| void JSScene::set_focus |
( |
Node |
elt | ) |
|
sets focus on element
- Parameters
-
| elt | the node on which focus should be set |
◆ show_keyboard()
| void JSScene::show_keyboard |
( |
boolean |
do_show | ) |
|
show or hide virtual keyboard
- Parameters
-
| do_show | if true, show keyboard, otherwise hide it |
◆ trigger_gc()
| void JSScene::trigger_gc |
( |
| ) |
|
triggers JS garbage collection pass
◆ get_object_manager()
| MediaObject JSScene::get_object_manager |
( |
DOMString |
url | ) |
|
gets object manager for the given service URL loaded in the root scene of the compositor
- Parameters
-
| url | url of service for which the object manager is queried |
- Returns
- the object manager, or null if not found
◆ switch_quality()
| void JSScene::switch_quality |
( |
boolean |
up | ) |
|
switches quality
- Parameters
-
| up | switches quality up (true) or down (false) |
◆ navigation_supported()
| boolean JSScene::navigation_supported |
( |
unsigned long |
nav_type | ) |
|
checks if navigation type is supported for the current content
- Parameters
-
| nav_type | the navigation type to check |
- Returns
- true if supported, false otherwise
◆ set_back_color()
| void JSScene::set_back_color |
( |
double |
r, |
|
|
double |
g, |
|
|
double |
b, |
|
|
double |
a |
|
) |
| |
sets default back color of player
- Parameters
-
| r | red component between 0.0 and 1.0 |
| g | green component between 0.0 and 1.0 |
| b | blue component between 0.0 and 1.0 |
| a | alpha component between 0.0 and 1.0 |
◆ fullscreen
| attribute boolean JSScene::fullscreen |
◆ current_path
| readonly DOMString JSScene::current_path |
current working directory
◆ volume
| attribute unsigned long JSScene::volume |
◆ navigation
| attribute unsigned long JSScene::navigation |
◆ navigation_type
| attribute unsigned long JSScene::navigation_type |
checks if navigation is off, 2D or 3D mode
◆ hardware_yuv
| readonly attribute boolean JSScene::hardware_yuv |
true if display has hardware yuv 2D blit
◆ hardware_rgb
| readonly attribute boolean JSScene::hardware_rgb |
true if display has hardware rgb 2D blit
◆ hardware_rgba
| readonly attribute boolean JSScene::hardware_rgba |
true if display has hardware rgba 2D blit
◆ hardware_stretch
| readonly attribute boolean JSScene::hardware_stretch |
true if display has hardware stretch blit
◆ screen_width
| readonly attribute unsigned long JSScene::screen_width |
◆ screen_height
| readonly attribute unsigned long JSScene::screen_height |
◆ fps
| readonly attribute double JSScene::fps |
◆ sim_fps
| readonly attribute double JSScene::sim_fps |
desired output fps for animations
◆ has_opengl
| readonly attribute boolean JSScene::has_opengl |
true if display has opengl support
◆ caption
| attribute DOMString JSScene::caption |
◆ focus_highlight
| attribute boolean JSScene::focus_highlight |
enables or disable focus highlighting
◆ dpi_x
| readonly attribute unsigned long JSScene::dpi_x |
◆ dpi_y
| readonly attribute unsigned long JSScene::dpi_y |
◆ sensors_active
| attribute boolean JSScene::sensors_active |
sensor active state (gyroscope)
◆ zoom
| readonly attribute double JSScene::zoom |
◆ text_selection
| readonly attribute DOMString JSScene::text_selection |
1.9.1