Struct Viewport

pub struct Viewport { /* private fields */ }

core class Viewport inherits Node (unsafe).

Official documentation

See the documentation of this class in the Godot engine’s official documentation.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

Viewport is an unsafe pointer, and all of its methods are unsafe.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Viewport::free.

Feature flag

This type is behind the gdnative crate’s common feature flag.

Class hierarchy

Viewport inherits methods from:

• Node
• Object

Implementations

impl Viewport

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 unsafe fn set_use_arvr(&mut self, _use: bool)

pub unsafe fn use_arvr(&mut self) -> bool

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

pub unsafe fn get_size(&self) -> Vector2

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

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

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

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

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

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

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

pub unsafe fn get_canvas_transform(&self) -> Transform2D

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

pub unsafe fn get_global_canvas_transform(&self) -> Transform2D

pub unsafe fn get_final_transform(&self) -> Transform2D

pub unsafe fn get_visible_rect(&self) -> Rect2

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

pub unsafe fn has_transparent_background(&self) -> bool

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

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

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

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

pub unsafe fn get_size_override(&self) -> Vector2

pub unsafe fn is_size_override_enabled(&self) -> bool

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

pub unsafe fn is_size_override_stretch_enabled(&self) -> bool

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

pub unsafe fn get_vflip(&self) -> bool

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

pub unsafe fn get_clear_mode(&self) -> ViewportClearMode

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

pub unsafe fn get_update_mode(&self) -> ViewportUpdateMode

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

pub unsafe fn get_msaa(&self) -> ViewportMSAA

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

pub unsafe fn get_hdr(&self) -> bool

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

pub unsafe fn get_usage(&self) -> ViewportUsage

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

pub unsafe fn get_debug_draw(&self) -> ViewportDebugDraw

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

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

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

pub unsafe fn get_physics_object_picking(&mut self) -> bool

pub unsafe fn get_viewport_rid(&self) -> Rid

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

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

pub unsafe fn update_worlds(&mut self)

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

pub unsafe fn is_using_own_world(&self) -> bool

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

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

pub unsafe fn is_audio_listener(&self) -> bool

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

pub unsafe fn is_audio_listener_2d(&self) -> bool

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

pub unsafe fn get_mouse_position(&self) -> Vector2

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

pub unsafe fn gui_has_modal_stack(&self) -> bool

pub unsafe fn gui_get_drag_data(&self) -> Variant

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

pub unsafe fn is_input_disabled(&self) -> bool

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

pub unsafe fn is_3d_disabled(&self) -> bool

pub unsafe fn set_keep_3d_linear(&mut self, keep_3d_linear: bool)

pub unsafe fn get_keep_3d_linear(&self) -> bool

pub unsafe fn _gui_show_tooltip(&mut self)

pub unsafe fn _gui_remove_focus(&mut self)

pub unsafe fn _post_gui_grab_click_focus(&mut self)

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

pub unsafe fn get_shadow_atlas_size(&self) -> i64

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

pub unsafe fn is_snap_controls_to_pixels_enabled(&self) -> bool

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

pub unsafe fn get_shadow_atlas_quadrant_subdiv( &self, quadrant: i64, ) -> ViewportShadowAtlasQuadrantSubdiv

pub unsafe fn _subwindow_visibility_changed(&mut self)

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn _enter_tree(&mut self)

Inherited from Node.

pub unsafe fn _exit_tree(&mut self)

Inherited from Node.

pub unsafe fn _ready(&mut self)

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_name(&self) -> GodotString

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_child_count(&self) -> i64

Inherited from Node.

pub unsafe fn get_children(&self) -> VariantArray

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_inside_tree(&self) -> bool

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_path(&self) -> NodePath

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_groups(&self) -> VariantArray

Inherited from Node.

pub unsafe fn raise(&mut self)

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn remove_and_skip(&mut self)

Inherited from Node.

pub unsafe fn get_index(&self) -> i64

Inherited from Node.

pub unsafe fn print_tree(&mut self)

Inherited from Node.

pub unsafe fn print_tree_pretty(&mut self)

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_filename(&self) -> GodotString

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_physics_process_delta_time(&self) -> f64

Inherited from Node.

pub unsafe fn is_physics_processing(&self) -> bool

Inherited from Node.

pub unsafe fn get_process_delta_time(&self) -> f64

Inherited from Node.

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

Inherited from Node.

pub unsafe fn set_process_priority(&mut self, priority: i64)

Inherited from Node.

pub unsafe fn is_processing(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_processing_input(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_processing_unhandled_input(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_processing_unhandled_key_input(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_pause_mode(&self) -> NodePauseMode

Inherited from Node.

pub unsafe fn can_process(&self) -> bool

Inherited from Node.

pub unsafe fn print_stray_nodes(&mut self)

Inherited from Node.

pub unsafe fn get_position_in_parent(&self) -> i64

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_displayed_folded(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_processing_internal(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_physics_processing_internal(&self) -> bool

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_scene_instance_load_placeholder(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn queue_free(&mut self)

Inherited from Node.

pub unsafe fn request_ready(&mut self)

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_network_master(&self) -> i64

Inherited from Node.

pub unsafe fn is_network_master(&self) -> bool

Inherited from Node.

pub unsafe fn get_multiplayer(&self) -> Option<MultiplayerAPI>

Inherited from Node.

pub unsafe fn get_custom_multiplayer(&self) -> Option<MultiplayerAPI>

Inherited from Node.

pub unsafe fn set_custom_multiplayer(&mut self, api: Option<MultiplayerAPI>)

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn _get_import_path(&self) -> NodePath

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn rpc_id( &mut self, peer_id: i64, method: GodotString, varargs: &[Variant], ) -> Variant

Inherited from Node.

pub unsafe fn rpc_unreliable_id( &mut self, peer_id: i64, method: GodotString, varargs: &[Variant], ) -> Variant

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn _notification(&mut self, what: i64)

Inherited from Object.

pub unsafe fn _set(&mut self, property: GodotString, value: Variant) -> bool

Inherited from Object.

pub unsafe fn _get(&mut self, property: GodotString) -> Variant

Inherited from Object.

pub unsafe fn _get_property_list(&mut self) -> VariantArray

Inherited from Object.

pub unsafe fn _init(&mut self)

Inherited from Object.

pub unsafe fn get_class(&self) -> GodotString

Inherited from Object.

pub unsafe fn is_class(&self, _type: GodotString) -> bool

Inherited from Object.

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

Inherited from Object.

pub unsafe fn get(&self, property: GodotString) -> Variant

Inherited from Object.

pub unsafe fn set_indexed(&mut self, property: NodePath, value: Variant)

Inherited from Object.

pub unsafe fn get_indexed(&self, property: NodePath) -> Variant

Inherited from Object.

pub unsafe fn get_property_list(&self) -> VariantArray

Inherited from Object.

pub unsafe fn get_method_list(&self) -> VariantArray

Inherited from Object.

pub unsafe fn notification(&mut self, what: i64, reversed: bool)

Inherited from Object.

pub unsafe fn get_instance_id(&self) -> i64

Inherited from Object.

pub unsafe fn set_script(&mut self, script: Option<Reference>)

Inherited from Object.

pub unsafe fn get_script(&self) -> Option<Reference>

Inherited from Object.

pub unsafe fn set_meta(&mut self, name: GodotString, value: Variant)

Inherited from Object.

pub unsafe fn get_meta(&self, name: GodotString) -> Variant

Inherited from Object.

pub unsafe fn has_meta(&self, name: GodotString) -> bool

Inherited from Object.

pub unsafe fn get_meta_list(&self) -> StringArray

Inherited from Object.

pub unsafe fn add_user_signal( &mut self, signal: GodotString, arguments: VariantArray, )

Inherited from Object.

pub unsafe fn has_user_signal(&self, signal: GodotString) -> bool

Inherited from Object.

pub unsafe fn emit_signal( &mut self, signal: GodotString, varargs: &[Variant], ) -> Variant

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

pub unsafe fn callv( &mut self, method: GodotString, arg_array: VariantArray, ) -> Variant

Inherited from Object.

pub unsafe fn has_method(&self, method: GodotString) -> bool

Inherited from Object.

pub unsafe fn get_signal_list(&self) -> VariantArray

Inherited from Object.

pub unsafe fn get_signal_connection_list( &self, signal: GodotString, ) -> VariantArray

Inherited from Object.

pub unsafe fn get_incoming_connections(&self) -> VariantArray

Inherited from Object.

pub unsafe fn connect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, binds: VariantArray, flags: i64, ) -> GodotResult

Inherited from Object.

pub unsafe fn disconnect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, )

Inherited from Object.

pub unsafe fn is_connected( &self, signal: GodotString, target: Option<Object>, method: GodotString, ) -> bool

Inherited from Object.

pub unsafe fn set_block_signals(&mut self, enable: bool)

Inherited from Object.

pub unsafe fn is_blocking_signals(&self) -> bool

Inherited from Object.

pub unsafe fn property_list_changed_notify(&mut self)

Inherited from Object.

pub unsafe fn set_message_translation(&mut self, enable: bool)

Inherited from Object.

pub unsafe fn can_translate_messages(&self) -> bool

Inherited from Object.

pub unsafe fn tr(&self, message: GodotString) -> GodotString

Inherited from Object.

pub unsafe fn is_queued_for_deletion(&self) -> bool

Inherited from Object.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

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

Generic dynamic cast.

Trait Implementations

impl Clone for Viewport

fn clone(&self) -> Viewport

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Viewport

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Free for Viewport

unsafe fn godot_free(self)

impl GodotObject for Viewport

fn class_name() -> &'static str

impl QueueFree for Viewport

unsafe fn godot_queue_free(&mut self)

impl ToVariant for Viewport

fn to_variant(&self) -> Variant

fn from_variant(variant: &Variant) -> Option<Self>

impl Copy for Viewport