Struct RenderSceneBuffersRd

#[repr(C)]
pub struct RenderSceneBuffersRd { /* private fields */ }

Expand description

Godot class RenderSceneBuffersRD.

Inherits RenderSceneBuffers.

Related symbols:

render_scene_buffers_rd: sidecar module with related enum/flag types
IRenderSceneBuffersRd: virtual methods

§Construction

This class is reference-counted. You can create a new instance using RenderSceneBuffersRd::new_gd().

Implementations§

§

impl RenderSceneBuffersRd

pub fn has_texture(&self, context: StringName, name: StringName) -> bool

pub fn create_texture( &mut self, context: StringName, name: StringName, data_format: DataFormat, usage_bits: u32, texture_samples: TextureSamples, size: Vector2i, layers: u32, mipmaps: u32, unique: bool, ) -> Rid

pub fn create_texture_from_format( &mut self, context: StringName, name: StringName, format: impl AsObjectArg<RdTextureFormat>, view: impl AsObjectArg<RdTextureView>, unique: bool, ) -> Rid

pub fn create_texture_view( &mut self, context: StringName, name: StringName, view_name: StringName, view: impl AsObjectArg<RdTextureView>, ) -> Rid

pub fn get_texture(&self, context: StringName, name: StringName) -> Rid

pub fn get_texture_format( &self, context: StringName, name: StringName, ) -> Option<Gd<RdTextureFormat>>

pub fn get_texture_slice( &mut self, context: StringName, name: StringName, layer: u32, mipmap: u32, layers: u32, mipmaps: u32, ) -> Rid

pub fn get_texture_slice_view( &mut self, context: StringName, name: StringName, layer: u32, mipmap: u32, layers: u32, mipmaps: u32, view: impl AsObjectArg<RdTextureView>, ) -> Rid

pub fn get_texture_slice_size( &mut self, context: StringName, name: StringName, mipmap: u32, ) -> Vector2i

pub fn clear_context(&mut self, context: StringName)

pub fn get_color_texture(&mut self) -> Rid

To set the default parameters, use Self::get_color_texture_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_color_texture_ex<'a>(&'a mut self) -> ExGetColorTexture<'a>

pub fn get_color_layer(&mut self, layer: u32) -> Rid

To set the default parameters, use Self::get_color_layer_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_color_layer_ex<'a>(&'a mut self, layer: u32) -> ExGetColorLayer<'a>

pub fn get_depth_texture(&mut self) -> Rid

To set the default parameters, use Self::get_depth_texture_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_depth_texture_ex<'a>(&'a mut self) -> ExGetDepthTexture<'a>

pub fn get_depth_layer(&mut self, layer: u32) -> Rid

To set the default parameters, use Self::get_depth_layer_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_depth_layer_ex<'a>(&'a mut self, layer: u32) -> ExGetDepthLayer<'a>

pub fn get_velocity_texture(&mut self) -> Rid

To set the default parameters, use Self::get_velocity_texture_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_velocity_texture_ex<'a>(&'a mut self) -> ExGetVelocityTexture<'a>

pub fn get_velocity_layer(&mut self, layer: u32) -> Rid

To set the default parameters, use Self::get_velocity_layer_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_velocity_layer_ex<'a>( &'a mut self, layer: u32, ) -> ExGetVelocityLayer<'a>

pub fn get_render_target(&self) -> Rid

pub fn get_view_count(&self) -> u32

pub fn get_internal_size(&self) -> Vector2i

pub fn get_target_size(&self) -> Vector2i

pub fn get_scaling_3d_mode(&self) -> ViewportScaling3DMode

pub fn get_fsr_sharpness(&self) -> f32

pub fn get_msaa_3d(&self) -> ViewportMsaa

pub fn get_texture_samples(&self) -> TextureSamples

pub fn get_screen_space_aa(&self) -> ViewportScreenSpaceAa

pub fn get_use_taa(&self) -> bool

pub fn get_use_debanding(&self) -> bool

Methods from Deref<Target = RenderSceneBuffers>§

pub fn configure( &mut self, config: impl AsObjectArg<RenderSceneBuffersConfiguration>, )

Methods from Deref<Target = RefCounted>§

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>§

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: GString) -> bool

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

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

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

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

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: StringName) -> bool

pub fn property_get_revert(&self, property: StringName) -> Variant

pub fn set_script(&mut self, script: &Variant)

pub fn get_script(&self) -> Variant

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

pub fn remove_meta(&mut self, name: StringName)

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

To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_meta_ex<'a>(&'a self, name: StringName) -> ExGetMeta<'a>

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

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: GString)

To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_user_signal_ex<'a>( &'a mut self, signal: GString, ) -> ExAddUserSignal<'a>

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

pub fn remove_user_signal(&mut self, signal: StringName)

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

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: StringName, varargs: &[Variant], ) -> Result<Error, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

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

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

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

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred(&mut self, property: StringName, value: &Variant)

pub fn callv( &mut self, method: StringName, arg_array: &Array<Variant>, ) -> Variant

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

pub fn get_method_argument_count(&self, method: StringName) -> i32

pub fn has_signal(&self, signal: StringName) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: StringName, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error

To set the default parameters, use Self::connect_ex and its builder methods. See the book for detailed usage instructions.

pub fn connect_ex<'a>( &'a mut self, signal: StringName, callable: Callable, ) -> ExConnect<'a>

pub fn disconnect(&mut self, signal: StringName, callable: Callable)

pub fn is_connected(&self, signal: StringName, callable: Callable) -> bool

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

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

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

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: StringName) -> GString

To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_ex<'a>(&'a self, message: StringName) -> ExTr<'a>

pub fn tr_n( &self, message: StringName, plural_message: StringName, n: i32, ) -> GString

To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_n_ex<'a>( &'a self, message: StringName, plural_message: StringName, n: i32, ) -> ExTrN<'a>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

§Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.