Struct gdnative::Viewport
[−]
[src]
pub struct Viewport { /* fields omitted */ }
core class Viewport : Node
(manually managed)
Base class
Viewport inherits Node and all of its methods.
Memory management
Non reference counted objects such as the ones of this type are usually owned by the engine.
In the cases where Rust code owns an object of this type, ownership should be either passed
to the engine or the object must be manually destroyed using Viewport::free
.
Methods
impl Viewport
[src]
pub fn as_node(&self) -> Node
[src]
Up-cast.
pub fn new() -> Self
[src]
Constructor.
Because this type is not reference counted, the lifetime of the returned object
is not automatically managed.
Immediately after creation, the object is owned by the caller, and can be
passed to the engine (in which case the engine will be responsible for
destroying the object) or destroyed manually using Viewport::free
.
pub unsafe fn free(self)
[src]
Manually deallocate the object.
pub fn set_use_arvr(&mut self, _use: bool)
[src]
pub fn use_arvr(&mut self) -> bool
[src]
pub fn set_size(&mut self, size: Vector2)
[src]
pub fn get_size(&self) -> Vector2
[src]
pub fn set_world_2d(&mut self, world_2d: Option<World2D>)
[src]
pub fn get_world_2d(&self) -> Option<World2D>
[src]
pub fn find_world_2d(&self) -> Option<World2D>
[src]
pub fn set_world(&mut self, world: Option<World>)
[src]
pub fn get_world(&self) -> Option<World>
[src]
pub fn find_world(&self) -> Option<World>
[src]
pub fn set_canvas_transform(&mut self, xform: Transform2D)
[src]
pub fn get_canvas_transform(&self) -> Transform2D
[src]
pub fn set_global_canvas_transform(&mut self, xform: Transform2D)
[src]
pub fn get_global_canvas_transform(&self) -> Transform2D
[src]
pub fn get_final_transform(&self) -> Transform2D
[src]
pub fn get_visible_rect(&self) -> Rect2
[src]
pub fn set_transparent_background(&mut self, enable: bool)
[src]
pub fn has_transparent_background(&self) -> bool
[src]
pub fn _vp_input(&mut self, arg0: Option<InputEvent>)
[src]
pub fn _vp_input_text(&mut self, text: GodotString)
[src]
pub fn _vp_unhandled_input(&mut self, arg0: Option<InputEvent>)
[src]
pub fn set_size_override(
&mut self,
enable: bool,
size: Vector2,
margin: Vector2
)
[src]
&mut self,
enable: bool,
size: Vector2,
margin: Vector2
)
pub fn get_size_override(&self) -> Vector2
[src]
pub fn is_size_override_enabled(&self) -> bool
[src]
pub fn set_size_override_stretch(&mut self, enabled: bool)
[src]
pub fn is_size_override_stretch_enabled(&self) -> bool
[src]
pub fn set_vflip(&mut self, enable: bool)
[src]
pub fn get_vflip(&self) -> bool
[src]
pub fn set_clear_mode(&mut self, mode: i64)
[src]
pub fn set_update_mode(&mut self, mode: i64)
[src]
pub fn set_msaa(&mut self, msaa: i64)
[src]
pub fn set_hdr(&mut self, enable: bool)
[src]
pub fn get_hdr(&self) -> bool
[src]
pub fn set_usage(&mut self, usage: i64)
[src]
pub fn set_debug_draw(&mut self, debug_draw: i64)
[src]
pub fn get_render_info(&mut self, info: i64) -> i64
[src]
pub fn get_texture(&self) -> Option<ViewportTexture>
[src]
pub fn set_physics_object_picking(&mut self, enable: bool)
[src]
pub fn get_physics_object_picking(&mut self) -> bool
[src]
pub fn get_viewport_rid(&self) -> Rid
[src]
pub fn input(&mut self, local_event: Option<InputEvent>)
[src]
pub fn unhandled_input(&mut self, local_event: Option<InputEvent>)
[src]
pub fn update_worlds(&mut self)
[src]
pub fn set_use_own_world(&mut self, enable: bool)
[src]
pub fn is_using_own_world(&self) -> bool
[src]
pub fn get_camera(&self) -> Option<Camera>
[src]
pub fn set_as_audio_listener(&mut self, enable: bool)
[src]
pub fn is_audio_listener(&self) -> bool
[src]
pub fn set_as_audio_listener_2d(&mut self, enable: bool)
[src]
pub fn is_audio_listener_2d(&self) -> bool
[src]
pub fn set_attach_to_screen_rect(&mut self, rect: Rect2)
[src]
pub fn get_mouse_position(&self) -> Vector2
[src]
pub fn warp_mouse(&mut self, to_position: Vector2)
[src]
pub fn gui_has_modal_stack(&self) -> bool
[src]
pub fn gui_get_drag_data(&self) -> Variant
[src]
pub fn set_disable_input(&mut self, disable: bool)
[src]
pub fn is_input_disabled(&self) -> bool
[src]
pub fn set_disable_3d(&mut self, disable: bool)
[src]
pub fn is_3d_disabled(&self) -> bool
[src]
pub fn _gui_show_tooltip(&mut self)
[src]
pub fn _gui_remove_focus(&mut self)
[src]
pub fn set_shadow_atlas_size(&mut self, size: i64)
[src]
pub fn get_shadow_atlas_size(&self) -> i64
[src]
pub fn set_snap_controls_to_pixels(&mut self, enabled: bool)
[src]
pub fn is_snap_controls_to_pixels_enabled(&self) -> bool
[src]
pub fn set_shadow_atlas_quadrant_subdiv(&mut self, quadrant: i64, subdiv: i64)
[src]
pub fn cast<T: GodotObject>(&self) -> Option<T>
[src]
Methods from Deref<Target = Node>
pub fn as_object(&self) -> Object
[src]
Up-cast.
pub fn _process(&mut self, delta: f64)
[src]
pub fn _physics_process(&mut self, delta: f64)
[src]
pub fn _enter_tree(&mut self)
[src]
pub fn _exit_tree(&mut self)
[src]
pub fn _ready(&mut self)
[src]
pub fn _input(&mut self, event: Option<InputEvent>)
[src]
pub fn _unhandled_input(&mut self, event: Option<InputEvent>)
[src]
pub fn _unhandled_key_input(&mut self, event: Option<InputEventKey>)
[src]
pub fn add_child_below_node(
&mut self,
node: Option<Object>,
child_node: Option<Object>,
legible_unique_name: bool
)
[src]
&mut self,
node: Option<Object>,
child_node: Option<Object>,
legible_unique_name: bool
)
pub fn set_name(&mut self, name: GodotString)
[src]
pub fn get_name(&self) -> GodotString
[src]
pub fn add_child(&mut self, node: Option<Object>, legible_unique_name: bool)
[src]
pub fn remove_child(&mut self, node: Option<Object>)
[src]
pub fn get_child_count(&self) -> i64
[src]
pub fn get_children(&self) -> VariantArray
[src]
pub fn get_child(&self, idx: i64) -> Option<Node>
[src]
pub fn has_node(&self, path: NodePath) -> bool
[src]
pub fn get_node(&self, path: NodePath) -> Option<Node>
[src]
pub fn get_parent(&self) -> Option<Node>
[src]
pub fn find_node(
&self,
mask: GodotString,
recursive: bool,
owned: bool
) -> Option<Node>
[src]
&self,
mask: GodotString,
recursive: bool,
owned: bool
) -> Option<Node>
pub fn has_node_and_resource(&self, path: NodePath) -> bool
[src]
pub fn get_node_and_resource(&mut self, path: NodePath) -> VariantArray
[src]
pub fn is_inside_tree(&self) -> bool
[src]
pub fn is_a_parent_of(&self, node: Option<Object>) -> bool
[src]
pub fn is_greater_than(&self, node: Option<Object>) -> bool
[src]
pub fn get_path(&self) -> NodePath
[src]
pub fn get_path_to(&self, node: Option<Object>) -> NodePath
[src]
pub fn add_to_group(&mut self, group: GodotString, persistent: bool)
[src]
pub fn remove_from_group(&mut self, group: GodotString)
[src]
pub fn is_in_group(&self, group: GodotString) -> bool
[src]
pub fn move_child(&mut self, child_node: Option<Object>, to_position: i64)
[src]
pub fn get_groups(&self) -> VariantArray
[src]
pub fn raise(&mut self)
[src]
pub fn set_owner(&mut self, owner: Option<Object>)
[src]
pub fn get_owner(&self) -> Option<Node>
[src]
pub fn remove_and_skip(&mut self)
[src]
pub fn get_index(&self) -> i64
[src]
pub fn print_tree(&mut self)
[src]
pub fn set_filename(&mut self, filename: GodotString)
[src]
pub fn get_filename(&self) -> GodotString
[src]
pub fn propagate_notification(&mut self, what: i64)
[src]
pub fn propagate_call(
&mut self,
method: GodotString,
args: VariantArray,
parent_first: bool
)
[src]
&mut self,
method: GodotString,
args: VariantArray,
parent_first: bool
)
pub fn set_physics_process(&mut self, enable: bool)
[src]
pub fn get_physics_process_delta_time(&self) -> f64
[src]
pub fn is_physics_processing(&self) -> bool
[src]
pub fn get_process_delta_time(&self) -> f64
[src]
pub fn set_process(&mut self, enable: bool)
[src]
pub fn is_processing(&self) -> bool
[src]
pub fn set_process_input(&mut self, enable: bool)
[src]
pub fn is_processing_input(&self) -> bool
[src]
pub fn set_process_unhandled_input(&mut self, enable: bool)
[src]
pub fn is_processing_unhandled_input(&self) -> bool
[src]
pub fn set_process_unhandled_key_input(&mut self, enable: bool)
[src]
pub fn is_processing_unhandled_key_input(&self) -> bool
[src]
pub fn set_pause_mode(&mut self, mode: i64)
[src]
pub fn can_process(&self) -> bool
[src]
pub fn print_stray_nodes(&mut self)
[src]
pub fn get_position_in_parent(&self) -> i64
[src]
pub fn set_display_folded(&mut self, fold: bool)
[src]
pub fn is_displayed_folded(&self) -> bool
[src]
pub fn set_process_internal(&mut self, enable: bool)
[src]
pub fn is_processing_internal(&self) -> bool
[src]
pub fn set_physics_process_internal(&mut self, enable: bool)
[src]
pub fn is_physics_processing_internal(&self) -> bool
[src]
pub fn get_tree(&self) -> Option<SceneTree>
[src]
pub fn duplicate(&self, flags: i64) -> Option<Node>
[src]
pub fn replace_by(&mut self, node: Option<Object>, keep_data: bool)
[src]
pub fn set_scene_instance_load_placeholder(&mut self, load_placeholder: bool)
[src]
pub fn get_scene_instance_load_placeholder(&self) -> bool
[src]
pub fn get_viewport(&self) -> Option<Viewport>
[src]
pub fn queue_free(&mut self)
[src]
pub fn request_ready(&mut self)
[src]
pub fn set_network_master(&mut self, id: i64, recursive: bool)
[src]
pub fn get_network_master(&self) -> i64
[src]
pub fn is_network_master(&self) -> bool
[src]
pub fn rpc_config(&mut self, method: GodotString, mode: i64)
[src]
pub fn rset_config(&mut self, property: GodotString, mode: i64)
[src]
pub fn _set_import_path(&mut self, import_path: NodePath)
[src]
pub fn _get_import_path(&self) -> NodePath
[src]
pub fn rpc(&mut self, method: GodotString, varargs: &[Variant]) -> Variant
[src]
pub fn rpc_unreliable(
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant
[src]
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant
pub fn rpc_id(
&mut self,
peer_id: i64,
method: GodotString,
varargs: &[Variant]
) -> Variant
[src]
&mut self,
peer_id: i64,
method: GodotString,
varargs: &[Variant]
) -> Variant
pub fn rpc_unreliable_id(
&mut self,
peer_id: i64,
method: GodotString,
varargs: &[Variant]
) -> Variant
[src]
&mut self,
peer_id: i64,
method: GodotString,
varargs: &[Variant]
) -> Variant
pub fn rset(&mut self, property: GodotString, value: Variant)
[src]
pub fn rset_id(&mut self, peer_id: i64, property: GodotString, value: Variant)
[src]
pub fn rset_unreliable(&mut self, property: GodotString, value: Variant)
[src]
pub fn rset_unreliable_id(
&mut self,
peer_id: i64,
property: GodotString,
value: Variant
)
[src]
&mut self,
peer_id: i64,
property: GodotString,
value: Variant
)
pub fn cast<T: GodotObject>(&self) -> Option<T>
[src]
Trait Implementations
impl GodotObject for Viewport
[src]
fn class_name() -> &'static str
[src]
unsafe fn from_sys(obj: *mut godot_object) -> Self
[src]
unsafe fn to_sys(&self) -> *mut godot_object
[src]
impl Deref for Viewport
[src]
type Target = Node
The resulting type after dereferencing.
fn deref(&self) -> &Self::Target
[src]
Dereferences the value.