Struct gdnative::Viewport

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

pub fn as_node(&self) -> Node

Up-cast.

pub fn new() -> Self

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)

Manually deallocate the object.

pub fn set_use_arvr(&mut self, _use: bool)

pub fn use_arvr(&mut self) -> bool

pub fn set_size(&mut self, size: Vector2)

pub fn get_size(&self) -> Vector2

pub fn set_world_2d(&mut self, world_2d: Option<World2D>)

pub fn get_world_2d(&self) -> Option<World2D>

pub fn find_world_2d(&self) -> Option<World2D>

pub fn set_world(&mut self, world: Option<World>)

pub fn get_world(&self) -> Option<World>

pub fn find_world(&self) -> Option<World>

pub fn set_canvas_transform(&mut self, xform: Transform2D)

pub fn get_canvas_transform(&self) -> Transform2D

pub fn set_global_canvas_transform(&mut self, xform: Transform2D)

pub fn get_global_canvas_transform(&self) -> Transform2D

pub fn get_final_transform(&self) -> Transform2D

pub fn get_visible_rect(&self) -> Rect2

pub fn set_transparent_background(&mut self, enable: bool)

pub fn has_transparent_background(&self) -> bool

pub fn _vp_input(&mut self, arg0: Option<InputEvent>)

pub fn _vp_input_text(&mut self, text: GodotString)

pub fn _vp_unhandled_input(&mut self, arg0: Option<InputEvent>)

pub fn set_size_override(
    &mut self,
    enable: bool,
    size: Vector2,
    margin: Vector2
)

pub fn get_size_override(&self) -> Vector2

pub fn is_size_override_enabled(&self) -> bool

pub fn set_size_override_stretch(&mut self, enabled: bool)

pub fn is_size_override_stretch_enabled(&self) -> bool

pub fn set_vflip(&mut self, enable: bool)

pub fn get_vflip(&self) -> bool

pub fn set_clear_mode(&mut self, mode: i64)

pub fn set_update_mode(&mut self, mode: i64)

pub fn set_msaa(&mut self, msaa: i64)

pub fn set_hdr(&mut self, enable: bool)

pub fn get_hdr(&self) -> bool

pub fn set_usage(&mut self, usage: i64)

pub fn set_debug_draw(&mut self, debug_draw: i64)

pub fn get_render_info(&mut self, info: i64) -> i64

pub fn get_texture(&self) -> Option<ViewportTexture>

pub fn set_physics_object_picking(&mut self, enable: bool)

pub fn get_physics_object_picking(&mut self) -> bool

pub fn get_viewport_rid(&self) -> Rid

pub fn input(&mut self, local_event: Option<InputEvent>)

pub fn unhandled_input(&mut self, local_event: Option<InputEvent>)

pub fn update_worlds(&mut self)

pub fn set_use_own_world(&mut self, enable: bool)

pub fn is_using_own_world(&self) -> bool

pub fn get_camera(&self) -> Option<Camera>

pub fn set_as_audio_listener(&mut self, enable: bool)

pub fn is_audio_listener(&self) -> bool

pub fn set_as_audio_listener_2d(&mut self, enable: bool)

pub fn is_audio_listener_2d(&self) -> bool

pub fn set_attach_to_screen_rect(&mut self, rect: Rect2)

pub fn get_mouse_position(&self) -> Vector2

pub fn warp_mouse(&mut self, to_position: Vector2)

pub fn gui_has_modal_stack(&self) -> bool

pub fn gui_get_drag_data(&self) -> Variant

pub fn set_disable_input(&mut self, disable: bool)

pub fn is_input_disabled(&self) -> bool

pub fn set_disable_3d(&mut self, disable: bool)

pub fn is_3d_disabled(&self) -> bool

pub fn _gui_show_tooltip(&mut self)

pub fn _gui_remove_focus(&mut self)

pub fn set_shadow_atlas_size(&mut self, size: i64)

pub fn get_shadow_atlas_size(&self) -> i64

pub fn set_snap_controls_to_pixels(&mut self, enabled: bool)

pub fn is_snap_controls_to_pixels_enabled(&self) -> bool

pub fn set_shadow_atlas_quadrant_subdiv(&mut self, quadrant: i64, subdiv: i64)

pub fn cast<T: GodotObject>(&self) -> Option<T>

Methods from Deref<Target = Node>

pub fn as_object(&self) -> Object

Up-cast.

pub fn _process(&mut self, delta: f64)

pub fn _physics_process(&mut self, delta: f64)

pub fn _enter_tree(&mut self)

pub fn _exit_tree(&mut self)

pub fn _ready(&mut self)

pub fn _input(&mut self, event: Option<InputEvent>)

pub fn _unhandled_input(&mut self, event: Option<InputEvent>)

pub fn _unhandled_key_input(&mut self, event: Option<InputEventKey>)

pub fn add_child_below_node(
    &mut self,
    node: Option<Object>,
    child_node: Option<Object>,
    legible_unique_name: bool
)

pub fn set_name(&mut self, name: GodotString)

pub fn get_name(&self) -> GodotString

pub fn add_child(&mut self, node: Option<Object>, legible_unique_name: bool)

pub fn remove_child(&mut self, node: Option<Object>)

pub fn get_child_count(&self) -> i64

pub fn get_children(&self) -> VariantArray

pub fn get_child(&self, idx: i64) -> Option<Node>

pub fn has_node(&self, path: NodePath) -> bool

pub fn get_node(&self, path: NodePath) -> Option<Node>

pub fn get_parent(&self) -> Option<Node>

pub fn find_node(
    &self,
    mask: GodotString,
    recursive: bool,
    owned: bool
) -> Option<Node>

pub fn has_node_and_resource(&self, path: NodePath) -> bool

pub fn get_node_and_resource(&mut self, path: NodePath) -> VariantArray

pub fn is_inside_tree(&self) -> bool

pub fn is_a_parent_of(&self, node: Option<Object>) -> bool

pub fn is_greater_than(&self, node: Option<Object>) -> bool

pub fn get_path(&self) -> NodePath

pub fn get_path_to(&self, node: Option<Object>) -> NodePath

pub fn add_to_group(&mut self, group: GodotString, persistent: bool)

pub fn remove_from_group(&mut self, group: GodotString)

pub fn is_in_group(&self, group: GodotString) -> bool

pub fn move_child(&mut self, child_node: Option<Object>, to_position: i64)

pub fn get_groups(&self) -> VariantArray

pub fn raise(&mut self)

pub fn set_owner(&mut self, owner: Option<Object>)

pub fn get_owner(&self) -> Option<Node>

pub fn remove_and_skip(&mut self)

pub fn get_index(&self) -> i64

pub fn print_tree(&mut self)

pub fn set_filename(&mut self, filename: GodotString)

pub fn get_filename(&self) -> GodotString

pub fn propagate_notification(&mut self, what: i64)

pub fn propagate_call(
    &mut self,
    method: GodotString,
    args: VariantArray,
    parent_first: bool
)

pub fn set_physics_process(&mut self, enable: bool)

pub fn get_physics_process_delta_time(&self) -> f64

pub fn is_physics_processing(&self) -> bool

pub fn get_process_delta_time(&self) -> f64

pub fn set_process(&mut self, enable: bool)

pub fn is_processing(&self) -> bool

pub fn set_process_input(&mut self, enable: bool)

pub fn is_processing_input(&self) -> bool

pub fn set_process_unhandled_input(&mut self, enable: bool)

pub fn is_processing_unhandled_input(&self) -> bool

pub fn set_process_unhandled_key_input(&mut self, enable: bool)

pub fn is_processing_unhandled_key_input(&self) -> bool

pub fn set_pause_mode(&mut self, mode: i64)

pub fn can_process(&self) -> bool

pub fn print_stray_nodes(&mut self)

pub fn get_position_in_parent(&self) -> i64

pub fn set_display_folded(&mut self, fold: bool)

pub fn is_displayed_folded(&self) -> bool

pub fn set_process_internal(&mut self, enable: bool)

pub fn is_processing_internal(&self) -> bool

pub fn set_physics_process_internal(&mut self, enable: bool)

pub fn is_physics_processing_internal(&self) -> bool

pub fn get_tree(&self) -> Option<SceneTree>

pub fn duplicate(&self, flags: i64) -> Option<Node>

pub fn replace_by(&mut self, node: Option<Object>, keep_data: bool)

pub fn set_scene_instance_load_placeholder(&mut self, load_placeholder: bool)

pub fn get_scene_instance_load_placeholder(&self) -> bool

pub fn get_viewport(&self) -> Option<Viewport>

pub fn queue_free(&mut self)

pub fn request_ready(&mut self)

pub fn set_network_master(&mut self, id: i64, recursive: bool)

pub fn get_network_master(&self) -> i64

pub fn is_network_master(&self) -> bool

pub fn rpc_config(&mut self, method: GodotString, mode: i64)

pub fn rset_config(&mut self, property: GodotString, mode: i64)

pub fn _set_import_path(&mut self, import_path: NodePath)

pub fn _get_import_path(&self) -> NodePath

pub fn rpc(&mut self, method: GodotString, varargs: &[Variant]) -> Variant

pub fn rpc_unreliable(
    &mut self,
    method: GodotString,
    varargs: &[Variant]
) -> Variant

pub fn rpc_id(
    &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

pub fn rset(&mut self, property: GodotString, value: Variant)

pub fn rset_id(&mut self, peer_id: i64, property: GodotString, value: Variant)

pub fn rset_unreliable(&mut self, property: GodotString, value: Variant)

pub fn rset_unreliable_id(
    &mut self,
    peer_id: i64,
    property: GodotString,
    value: Variant
)

pub fn cast<T: GodotObject>(&self) -> Option<T>

Trait Implementations

impl GodotObject for Viewport

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

unsafe fn to_sys(&self) -> *mut godot_object

impl Deref for Viewport

type Target = Node

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Viewport

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.