Struct gdnative_bindings::VisualServer

source ·

pub struct VisualServer { /* private fields */ }

Expand description

core singleton class VisualServer inherits Object (manually managed).

This class has related types in the visual_server module.

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Class hierarchy

VisualServer inherits methods from:

Object

All types in the Godot API have interior mutability in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Ownership in these types tracks whether ownership is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations§

source §

impl VisualServer

Constants

source

pub unsafe fn godot_singleton() -> &'static Self

Returns a reference to the singleton instance.

Safety

This singleton server is only safe to access from outside the main thread if thread-safe operations are enabled in the project settings. See the official thread-safety guidelines for more information.

source

pub unsafe fn black_bars_set_images(
    &self,
    left: Rid,
    top: Rid,
    right: Rid,
    bottom: Rid
)

Sets images to be rendered in the window margin.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

source

pub fn black_bars_set_margins(&self, left: i64, top: i64, right: i64, bottom: i64)

Sets margin size, where black bars (or images, if black_bars_set_images was used) are rendered.

width - 1.0
antialiased - false

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

source

pub unsafe fn canvas_item_add_mesh(
    &self,
    item: Rid,
    mesh: Rid,
    transform: Transform2D,
    modulate: Color,
    texture: Rid,
    normal_map: Rid
)

Adds a mesh command to the CanvasItem’s draw commands.

Default Arguments

transform - Transform2D( 1, 0, 0, 1, 0, 0 )
modulate - Color( 1, 1, 1, 1 )

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

source

pub unsafe fn canvas_item_add_multimesh(
    &self,
    item: Rid,
    mesh: Rid,
    texture: Rid,
    normal_map: Rid
)

Adds a MultiMesh to the CanvasItem’s draw commands. Only affects its aabb at the moment.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

source

pub unsafe fn canvas_item_add_nine_patch(
    &self,
    item: Rid,
    rect: Rect2,
    source: Rect2,
    texture: Rid,
    topleft: Vector2,
    bottomright: Vector2,
    x_axis_mode: i64,
    y_axis_mode: i64,
    draw_center: bool,
    modulate: Color,
    normal_map: Rid
)

Adds a nine patch image to the CanvasItem’s draw commands. See NinePatchRect for more explanation.

Default Arguments

x_axis_mode - 0
y_axis_mode - 0
draw_center - true
modulate - Color( 1, 1, 1, 1 )

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Default Arguments

tile - false
modulate - Color( 1, 1, 1, 1 )
transpose - false

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

source

pub unsafe fn canvas_item_add_texture_rect_region(
    &self,
    item: Rid,
    rect: Rect2,
    texture: Rid,
    src_rect: Rect2,
    modulate: Color,
    transpose: bool,
    normal_map: Rid,
    clip_uv: bool
)

Adds a texture rect with region setting to the CanvasItem’s draw commands.

Default Arguments

modulate - Color( 1, 1, 1, 1 )
transpose - false
clip_uv - true

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

source

pub unsafe fn canvas_item_add_triangle_array(
 &self,
 item: Rid,
 indices: PoolArray<i32>,
 points: PoolArray<Vector2>,
 colors: PoolArray<Color>,
 uvs: PoolArray<Vector2>,
 bones: PoolArray<i32>,
 weights: PoolArray<f32>,
 texture: Rid,
 count: i64,
 normal_map: Rid,
 antialiased: bool,
 antialiasing_use_indices: bool
)

Adds a triangle array to the CanvasItem’s draw commands.

Default Arguments

uvs - PoolVector2Array( )
bones - PoolIntArray( )
weights - PoolRealArray( )
count - -1
antialiased - false
antialiasing_use_indices - false

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

source

pub unsafe fn canvas_item_clear(&self, item: Rid)

Clears the CanvasItem and removes all commands in it.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Defines a custom drawing rectangle for the CanvasItem.

Default Arguments

rect - Rect2( 0, 0, 0, 0 )

source

pub unsafe fn canvas_light_occluder_attach_to_canvas(
    &self,
    occluder: Rid,
    canvas: Rid
)

Attaches a light occluder to the canvas. Removes it from its previous canvas.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

pub fn draw(&self, swap_buffers: bool, frame_step: f64)

Draws a frame. This method is deprecated, please use force_draw instead.

Default Arguments

swap_buffers - true
frame_step - 0.0

source

pub fn environment_create(&self) -> Rid

Creates an environment and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all environment_* VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer’s free_rid static method.

source

pub unsafe fn environment_set_adjustment(
    &self,
    env: Rid,
    enable: bool,
    brightness: f64,
    contrast: f64,
    saturation: f64,
    ramp: Rid
)

Sets the values to be used with the “Adjustment” post-process effect. See Environment for more details.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

source

pub unsafe fn environment_set_ambient_light(
    &self,
    env: Rid,
    color: Color,
    energy: f64,
    sky_contibution: f64
)

Sets the ambient light parameters. See Environment for more details.

Default Arguments

energy - 1.0
sky_contibution - 0.0

source

pub fn force_draw(&self, swap_buffers: bool, frame_step: f64)

Forces a frame to be drawn when the function is called. Drawing a frame updates all Viewports that are set to update. Use with extreme caution.

Default Arguments

swap_buffers - true
frame_step - 0.0

source

pub fn force_sync(&self)

Synchronizes threads.

source

Not yet implemented. Always returns false.

pub unsafe fn instance_attach_object_instance_id(&self, instance: Rid, id: i64)

Attaches a unique Object ID to instance. Object ID must be attached to instance for proper culling with instances_cull_aabb, instances_cull_convex, and instances_cull_ray.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

source

pub unsafe fn instance_attach_skeleton(&self, instance: Rid, skeleton: Rid)

Attaches a skeleton to an instance. Removes the previous skeleton from the instance.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets the lightmap to use with this instance.

Default Arguments

lightmap_slice - -1
lightmap_uv_rect - Rect2( 0, 0, 1, 1 )

Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions.

Adds a surface generated from the Arrays to a mesh. See PrimitiveType constants for types.

Default Arguments

blend_shapes - [ ]
compress_format - 2194432

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

source

pub unsafe fn mesh_clear(&self, mesh: Rid)

Removes all surfaces from a mesh.

Safety

Function is unused in Godot 3.x.

source

custom_data_format - 0

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative.

All data is packed in one large float array. An array may look like this: Transform for instance 1, color data for instance 1, custom data for instance 1, transform for instance 2, color data for instance 2, etc.

Creates a new omni light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID can be used in most light_* VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer’s free_rid static method. To place in a scene, attach this omni light to an instance using instance_set_base using the returned RID.

Allocates the GPU buffers for this skeleton.

Default Arguments

is_2d_skeleton - false

source

pub unsafe fn skeleton_get_bone_count(&self, skeleton: Rid) -> i64

Returns the number of bones allocated for this skeleton.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

source

pub fn sky_create(&self) -> Rid

Creates an empty sky and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all sky_* VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer’s free_rid static method.

source

pub unsafe fn sky_set_texture(&self, sky: Rid, cube_map: Rid, radiance_size: i64)

Sets a sky’s texture.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

source

pub fn spot_light_create(&self) -> Rid

Creates a spot light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID can be used in most light_* VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer’s free_rid static method. To place in a scene, attach this spot light to an instance using instance_set_base using the returned RID.

source

pub fn sync(&self)

Not implemented in Godot 3.x.

source

pub unsafe fn texture_allocate(
    &self,
    texture: Rid,
    width: i64,
    height: i64,
    depth_3d: i64,
    format: i64,
    type_: i64,
    flags: i64
)

Allocates the GPU memory for the texture.

Default Arguments

flags - 7

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

source

pub unsafe fn texture_bind(&self, texture: Rid, number: i64)

Binds the texture to a texture slot.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

source

pub fn texture_create(&self) -> Rid

Creates an empty texture and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all texture_* VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer’s free_rid static method.

source

pub fn texture_create_from_image(
 &self,
 image: impl AsArg<Image>,
 flags: i64
) -> Rid

Creates a texture, allocates the space for an image, and fills in the image.

Default Arguments

flags - 7

source

pub fn texture_debug_usage(&self) -> VariantArray

Returns a list of all the textures and their information.

source

pub unsafe fn texture_get_data(
 &self,
 texture: Rid,
 cube_side: i64
) -> Option<Ref<Image, Shared>>

Returns a copy of a texture’s image unless it’s a CubeMap, in which case it returns the RID of the image at one of the cubes sides.

Default Arguments

cube_side - 0

Default Arguments

layer - 0

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

source

pub unsafe fn texture_set_data_partial(
 &self,
 texture: Rid,
 image: impl AsArg<Image>,
 src_x: i64,
 src_y: i64,
 src_w: i64,
 src_h: i64,
 dst_x: i64,
 dst_y: i64,
 dst_mip: i64,
 layer: i64
)

Sets a part of the data for a texture. Warning: this function calls the underlying graphics API directly and may corrupt your texture if used improperly.

Default Arguments

layer - 0

Creates an update link between two textures, similar to how ViewportTextures operate. When the base texture is the texture of a Viewport, every time the viewport renders a new frame, the proxy texture automatically receives an update. For example, this code links a generic ImageTexture to the texture output of the Viewport using the VisualServer API:

func _ready():
    var viewport_rid = get_viewport().get_viewport_rid()
    var viewport_texture_rid = VisualServer.viewport_get_texture(viewport_rid)

    var proxy_texture = ImageTexture.new()
    var viewport_texture_image_data = VisualServer.texture_get_data(viewport_texture_rid)

    proxy_texture.create_from_image(viewport_texture_image_data)
    var proxy_texture_rid = proxy_texture.get_rid()
    VisualServer.texture_set_proxy(proxy_texture_rid, viewport_texture_rid)

    $TextureRect.texture = proxy_texture

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

source

pub fn texture_set_shrink_all_x2_on_set_data(&self, shrink: bool)

If true, sets internal processes to shrink all image data to half the size.

source

pub unsafe fn texture_set_size_override(
    &self,
    texture: Rid,
    width: i64,
    height: i64,
    depth: i64
)

Resizes the texture to the specified dimensions.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sample code is GDScript unless otherwise noted.

Copies viewport to a region of the screen specified by rect. If [Viewport.render_direct_to_screen][Viewport::render_direct_to_screen] is true, then viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to. For example, you can set the root viewport to not render at all with the following code:

func _ready():
    get_viewport().set_attach_to_screen_rect(Rect2())
    $Viewport.set_attach_to_screen_rect(Rect2(0, 0, 600, 600))

Using this can result in significant optimization, especially on lower-end devices. However, it comes at the cost of having to manage your viewports manually. For further optimization, see viewport_set_render_direct_to_screen.

Default Arguments

rect - Rect2( 0, 0, 0, 0 )
screen - 0

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Adds a user-defined signal. Arguments are optional, but can be added as an Array of dictionaries, each containing name: String and type: int (see [enum Variant.Type]) entries.

Default Arguments

arguments - [ ]

source

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

Sample code is GDScript unless otherwise noted.

Calls the method on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

call("set", "position", Vector2(42.0, 0.0))

Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).

Safety

This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).

source

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

Sample code is GDScript unless otherwise noted.

Calls the method on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

call_deferred("set", "position", Vector2(42.0, 0.0))

Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).

Safety

This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).

source

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

Sample code is GDScript unless otherwise noted.

Calls the method on the object and returns the result. Contrarily to call, this method does not support a variable number of arguments but expects all parameters to be via a single Array.

callv("set", [ "position", Vector2(42.0, 0.0) ])

Safety

This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).

source

pub fn can_translate_messages(&self) -> bool

Returns true if the object can translate strings. See set_message_translation and tr.

source

pub fn connect(
 &self,
 signal: impl Into<GodotString>,
 target: impl AsArg<Object>,
 method: impl Into<GodotString>,
 binds: VariantArray,
 flags: i64
) -> GodotResult

Sample code is GDScript unless otherwise noted.

Connects a signal to a method on a target object. Pass optional binds to the call as an Array of parameters. These parameters will be passed to the method after any parameter used in the call to emit_signal. Use flags to set deferred or one-shot connections. See ConnectFlags constants. A signal can only be connected once to a method. It will print an error if already connected, unless the signal was connected with CONNECT_REFERENCE_COUNTED. To avoid this, first, use is_connected to check for existing connections. If the target is destroyed in the game’s lifecycle, the connection will be lost. Examples:

connect("pressed", self, "_on_Button_pressed") # BaseButton signal
connect("text_entered", self, "_on_LineEdit_text_entered") # LineEdit signal
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # User-defined signal

An example of the relationship between binds passed to connect and parameters used when calling emit_signal:

connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # weapon_type and damage are passed last
emit_signal("hit", "Dark lord", 5) # "Dark lord" and 5 are passed first
func _on_Player_hit(hit_by, level, weapon_type, damage):
    print("Hit by %s (lvl %d) with weapon %s for %d damage" % [hit_by, level, weapon_type, damage])

Default Arguments

binds - [ ]
flags - 0

source

pub fn disconnect(
 &self,
 signal: impl Into<GodotString>,
 target: impl AsArg<Object>,
 method: impl Into<GodotString>
)

Disconnects a signal from a method on the given target. If you try to disconnect a connection that does not exist, the method will print an error. Use is_connected to ensure that the connection exists.

source

pub fn emit_signal(
 &self,
 signal: impl Into<GodotString>,
 varargs: &[Variant]
) -> Variant

Sample code is GDScript unless otherwise noted.

Emits the given signal. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

emit_signal("hit", weapon_type, damage)
emit_signal("game_over")

source

pub fn get(&self, property: impl Into<GodotString>) -> Variant

Returns the Variant value of the given property. If the property doesn’t exist, this will return null. Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

source

pub fn get_class(&self) -> GodotString

Returns the object’s class as a String. See also is_class. Note: get_class does not take class_name declarations into account. If the object has a class_name defined, the base class name will be returned instead.

source

pub fn get_incoming_connections(&self) -> VariantArray

Returns an Array of dictionaries with information about signals that are connected to the object. Each Dictionary contains three String entries:

source is a reference to the signal emitter.
signal_name is the name of the connected signal.
method_name is the name of the method to which the signal is connected.

source

pub fn get_indexed(&self, property: impl Into<NodePath>) -> Variant

Gets the object’s property indexed by the given NodePath. The node path should be relative to the current object and can use the colon character (:) to access nested properties. Examples: "position:x" or "material:next_pass:blend_mode". Note: Even though the method takes NodePath argument, it doesn’t support actual paths to Nodes in the scene tree, only colon-separated sub-property paths. For the purpose of nodes, use Node.get_node_and_resource instead.

source

pub fn get_instance_id(&self) -> i64

Returns the object’s unique instance ID. This ID can be saved in EncodedObjectAsID, and can be used to retrieve the object instance with [method @GDScript.instance_from_id].

source

pub fn get_meta(
 &self,
 name: impl Into<GodotString>,
 default: impl OwnedToVariant
) -> Variant

Returns the object’s metadata entry for the given name. Throws error if the entry does not exist, unless default is not null (in which case the default value will be returned).

Default Arguments

default - null

source

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

Send a given notification to the object, which will also trigger a call to the [_notification][Self::_notification] method of all classes that the object inherits from. If reversed is true, [_notification][Self::_notification] is called first on the object’s own class, and then up to its successive parent classes. If reversed is false, [_notification][Self::_notification] is called first on the highest ancestor (Object itself), and then down to its successive inheriting classes.

Default Arguments

reversed - false

Assigns a new value to the property identified by the NodePath. The node path should be relative to the current object and can use the colon character (:) to access nested properties. Example:

set_indexed("position", Vector2(42, 0))
set_indexed("position:y", -10)
print(position) # (42, -10)

source

pub fn set_message_translation(&self, enable: bool)

Defines whether the object can translate strings (with calls to tr). Enabled by default.

source

pub fn set_meta(&self, name: impl Into<GodotString>, value: impl OwnedToVariant)

Adds, changes or removes a given entry in the object’s metadata. Metadata are serialized and can take any Variant value. To remove a given entry from the object’s metadata, use remove_meta. Metadata is also removed if its value is set to null. This means you can also use set_meta("name", null) to remove metadata for "name".

source

pub fn set_script(&self, script: impl AsArg<Reference>)

Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality. If the object already had a script, the previous script instance will be freed and its variables and state will be lost. The new script’s [_init][Self::_init] method will be called.

source

pub fn to_string(&self) -> GodotString

Returns a String representing the object. If not overridden, defaults to "[ClassName:RID]". Override the method [_to_string][Self::_to_string] to customize the String representation.

source

pub fn tr(&self, message: impl Into<GodotString>) -> GodotString

Translates a message using translation catalogs configured in the Project Settings. Only works if message translation is enabled (which it is by default), otherwise it returns the message unchanged. See set_message_translation.