RenderSceneBuffersRD

Inherits: RenderSceneBuffers < RefCounted < Object

Abstract render scene buffer implementation for the RenderingDevice based renderers.

Description

This object manages all 3D rendering buffers for the rendering device based renderers. An instance of this object is created for every viewport that has 3D rendering enabled.

All buffers are organized in contexts. The default context is called render_buffers and can contain amongst others the color buffer, depth buffer, velocity buffers, VRS density map and MSAA variants of these buffers.

Buffers are only guaranteed to exist during rendering of the viewport.

Note: this is an internal rendering server object only exposed for GDExtension plugins.

Methods

void

clear_context ( StringName context )

RID

create_texture ( StringName context, StringName name, DataFormat data_format, int usage_bits, TextureSamples texture_samples, Vector2i size, int layers, int mipmaps, bool unique )

RID

create_texture_from_format ( StringName context, StringName name, RDTextureFormat format, RDTextureView view, bool unique )

RID

create_texture_view ( StringName context, StringName name, StringName view_name, RDTextureView view )

RID

get_color_layer ( int layer )

RID

get_color_texture ( )

RID

get_depth_layer ( int layer )

RID

get_depth_texture ( )

Vector2i

get_internal_size ( ) const

RID

get_render_target ( ) const

RID

get_texture ( StringName context, StringName name ) const

RDTextureFormat

get_texture_format ( StringName context, StringName name ) const

RID

get_texture_slice ( StringName context, StringName name, int layer, int mipmap, int layers, int mipmaps )

Vector2i

get_texture_slice_size ( StringName context, StringName name, int mipmap )

bool

get_use_taa ( ) const

RID

get_velocity_layer ( int layer )

RID

get_velocity_texture ( )

int

get_view_count ( ) const

bool

has_texture ( StringName context, StringName name ) const


Method Descriptions

void clear_context ( StringName context )

Frees all buffers related to this context.


RID create_texture ( StringName context, StringName name, DataFormat data_format, int usage_bits, TextureSamples texture_samples, Vector2i size, int layers, int mipmaps, bool unique )

Create a new texture with the given definition and cache this under the given name. Will return the existing texture if it already exists.


RID create_texture_from_format ( StringName context, StringName name,