RenderSceneBuffersRD — C# API

Реализация буфера рендеринга сцены для рендереров на основе RenderingDevice.

class RenderSceneBuffersRDReckfellSharpНаследует RenderSceneBuffers

Реализация буфера рендеринга сцены для рендереров на основе RenderingDevice.

Этот объект управляет всеми буферами 3D-рендеринга для рендереров, использующих устройства рендеринга. Экземпляр этого объекта создается для каждого видового окна, в котором включен 3D-рендеринг. См. также RenderSceneBuffers. Все буферы организованы в контексты. Контекст по умолчанию называется render_buffers и может содержать, помимо прочего, буфер цвета, буфер глубины, буферы скорости, карту плотности VRS и варианты MSAA этих буферов. Существование буферов гарантируется только во время рендеринга видового окна. Примечание: Это внутренний объект сервера рендеринга. Не создавайте экземпляр этого класса из скрипта.

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Конструкторы1

RenderSceneBuffersRDКонструктор

# RenderSceneBuffersRD

C#
public RenderSceneBuffersRD();

Методы34

ClearContextvoid

# ClearContext

C#
public void ClearContext(StringName context);

Освобождает все буферы, связанные с этим контекстом.

Параметры
Имя	Тип	По умолчанию
`context`	`StringName`	—

CreateTexture2 перегрузки

# CreateTexture · 1/2

C#
public Rid CreateTexture(StringName context, StringName name, RenderingDevice.DataFormat dataFormat, uint usageBits, RenderingDevice.TextureSamples textureSamples, Vector2I size, uint layers, uint mipmaps, bool unique);

Создать новую текстуру с заданным определением и кэшировать ее под заданным именем. Возвращает существующую текстуру, если она уже существует.

Параметры
Имя	Тип	По умолчанию
`context`	`StringName`	—
`name`	`StringName`	—
`dataFormat`	`RenderingDevice.DataFormat`	—
`usageBits`	`uint`	—
`textureSamples`	`RenderingDevice.TextureSamples`	—
`size`	`Vector2I`	—
`layers`	`uint`	—
`mipmaps`	`uint`	—
`unique`	`bool`	—

Возвращает Rid

# CreateTexture · 2/2

C#
public Rid CreateTexture(StringName context, StringName name, RenderingDevice.DataFormat dataFormat, uint usageBits, RenderingDevice.TextureSamples textureSamples, Vector2I size, uint layers, uint mipmaps, bool unique, bool discardable);

Параметры
Имя	Тип	По умолчанию
`context`	`StringName`	—
`name`	`StringName`	—
`dataFormat`	`RenderingDevice.DataFormat`	—
`usageBits`	`uint`	—
`textureSamples`	`RenderingDevice.TextureSamples`	—
`size`	`Vector2I`	—
`layers`	`uint`	—
`mipmaps`	`uint`	—
`unique`	`bool`	—
`discardable`	`bool`	—

Возвращает Rid

CreateTextureFromFormatRid

# CreateTextureFromFormat

C#
public Rid CreateTextureFromFormat(StringName context, StringName name, RDTextureFormat format, RDTextureView view, bool unique);

Создать новую текстуру, используя заданный формат, просмотреть и кэшировать ее под заданным именем. Возвращает существующую текстуру, если она уже существует.

Параметры
Имя	Тип	По умолчанию
`context`	`StringName`	—
`name`	`StringName`	—
`format`	`RDTextureFormat`	—
`view`	`RDTextureView`	—
`unique`	`bool`	—

Возвращает Rid

CreateTextureViewRid

# CreateTextureView

C#
public Rid CreateTextureView(StringName context, StringName name, StringName viewName, RDTextureView view);

Создать новый вид текстуры для существующей текстуры и кэшировать его под заданным view_name. Возвращает существующий вид текстуры, если он уже существует. Выдает ошибку, если исходная текстура не существует.

Параметры
Имя	Тип	По умолчанию
`context`	`StringName`	—
`name`	`StringName`	—
`viewName`	`StringName`	—
`view`	`RDTextureView`	—

Возвращает Rid

GetColorLayer2 перегрузки

# GetColorLayer · 1/2

C#
public Rid GetColorLayer(uint layer);

Возвращает указанный слой из цветовой текстуры, в которую мы визуализируем 3D-контент. Если msaa равен true и включен MSAA, возвращается вариант MSAA буфера.

Параметры
Имя	Тип	По умолчанию
`layer`	`uint`	—

Возвращает Rid

# GetColorLayer · 2/2

C#
public Rid GetColorLayer(uint layer, bool msaa = false);

Параметры
Имя	Тип	По умолчанию
`layer`	`uint`	—
`msaa`	`bool`	`false`

Возвращает Rid

GetColorTexture2 перегрузки

# GetColorTexture · 1/2

C#
public Rid GetColorTexture();

Возвращает цветовую текстуру, в которую мы визуализируем 3D-контент. Если используется multiview, это будет массив текстур со всеми представлениями. Если msaa равен true и включен MSAA, возвращается вариант MSAA буфера.

Возвращает Rid

# GetColorTexture · 2/2

C#
public Rid GetColorTexture(bool msaa = false);

Параметры
Имя	Тип	По умолчанию
`msaa`	`bool`	`false`

Возвращает Rid

GetDepthLayer2 перегрузки

# GetDepthLayer · 1/2

C#
public Rid GetDepthLayer(uint layer);

Возвращает указанный слой из текстуры глубины, в которую мы визуализируем 3D-контент. Если msaa равен true и включен MSAA, возвращается вариант MSAA буфера.

Параметры
Имя	Тип	По умолчанию
`layer`	`uint`	—

Возвращает Rid

# GetDepthLayer · 2/2

C#
public Rid GetDepthLayer(uint layer, bool msaa = false);

Параметры
Имя	Тип	По умолчанию
`layer`	`uint`	—
`msaa`	`bool`	`false`

Возвращает Rid

GetDepthTexture2 перегрузки

# GetDepthTexture · 1/2

C#
public Rid GetDepthTexture();

Возвращает текстуру глубины, в которую мы визуализируем 3D-контент. Если используется multiview, это будет массив текстур со всеми представлениями. Если msaa равен true и включен MSAA, возвращается вариант MSAA буфера.

Возвращает Rid

# GetDepthTexture · 2/2

C#
public Rid GetDepthTexture(bool msaa = false);

Параметры
Имя	Тип	По умолчанию
`msaa`	`bool`	`false`

Возвращает Rid

GetFsrSharpnessfloat

# GetFsrSharpness

C#
public float GetFsrSharpness();

Возвращает значение резкости FSR, используемое при рендеринге 3D-контента (если RenderSceneBuffersRD.GetScaling3DMode является режимом FSR).

Возвращает float

GetInternalSizeVector2I

# GetInternalSize

C#
public Vector2I GetInternalSize();

Возвращает внутренний размер буфера рендеринга (размер до масштабирования), с которым по умолчанию создаются текстуры.

Возвращает Vector2I

GetMsaa3DRenderingServer.ViewportMsaa

# GetMsaa3D

C#
public RenderingServer.ViewportMsaa GetMsaa3D();

Возвращает примененный режим 3D MSAA для данного окна просмотра.

Возвращает RenderingServer.ViewportMsaa

GetRenderTargetRid

# GetRenderTarget

C#
public Rid GetRenderTarget();

Возвращает цель рендеринга, связанную с этим объектом буферов.

Возвращает Rid

GetScaling3DModeRenderingServer.ViewportScaling3DMode

# GetScaling3DMode

C#
public RenderingServer.ViewportScaling3DMode GetScaling3DMode();

Возвращает режим масштабирования, используемый для масштабирования.

Возвращает RenderingServer.ViewportScaling3DMode

GetScreenSpaceAARenderingServer.ViewportScreenSpaceAA

# GetScreenSpaceAA

C#
public RenderingServer.ViewportScreenSpaceAA GetScreenSpaceAA();

Возвращает примененный метод сглаживания экранного пространства.

Возвращает RenderingServer.ViewportScreenSpaceAA

GetTargetSizeVector2I

# GetTargetSize

C#
public Vector2I GetTargetSize();

Возвращает целевой размер буфера рендеринга (размер после масштабирования).

Возвращает Vector2I

GetTextureRid

# GetTexture

C#
public Rid GetTexture(StringName context, StringName name);

Возвращает кэшированную текстуру с этим именем.

Параметры
Имя	Тип	По умолчанию
`context`	`StringName`	—
`name`	`StringName`	—

Возвращает Rid

GetTextureFormatRDTextureFormat

# GetTextureFormat

C#
public RDTextureFormat GetTextureFormat(StringName context, StringName name);

Возвращает информацию о формате текстуры, с помощью которой была создана кэшированная текстура.

Параметры
Имя	Тип	По умолчанию
`context`	`StringName`	—
`name`	`StringName`	—

Возвращает RDTextureFormat

GetTextureSamplesRenderingDevice.TextureSamples

# GetTextureSamples

C#
public RenderingDevice.TextureSamples GetTextureSamples();

Возвращает количество использованных выборок MSAA.

Возвращает RenderingDevice.TextureSamples

GetTextureSliceRid

# GetTextureSlice

C#
public Rid GetTextureSlice(StringName context, StringName name, uint layer, uint mipmap, uint layers, uint mipmaps);

Возвращает определенный фрагмент (слой или MIP-карту) для кэшированной текстуры.

Параметры
Имя	Тип	По умолчанию
`context`	`StringName`	—
`name`	`StringName`	—
`layer`	`uint`	—
`mipmap`	`uint`	—
`layers`	`uint`	—
`mipmaps`	`uint`	—

Возвращает Rid

GetTextureSliceSizeVector2I

# GetTextureSliceSize

C#
public Vector2I GetTextureSliceSize(StringName context, StringName name, uint mipmap);

Возвращает размер текстуры заданного фрагмента кэшированной текстуры.

Параметры
Имя	Тип	По умолчанию
`context`	`StringName`	—
`name`	`StringName`	—
`mipmap`	`uint`	—

Возвращает Vector2I

GetTextureSliceViewRid

# GetTextureSliceView

C#
public Rid GetTextureSliceView(StringName context, StringName name, uint layer, uint mipmap, uint layers, uint mipmaps, RDTextureView view);

Возвращает определенный вид среза (слоя или MIP-карты) для кэшированной текстуры.

Параметры
Имя	Тип	По умолчанию
`context`	`StringName`	—
`name`	`StringName`	—
`layer`	`uint`	—
`mipmap`	`uint`	—
`layers`	`uint`	—
`mipmaps`	`uint`	—
`view`	`RDTextureView`	—

Возвращает Rid

GetUseDebandingbool

# GetUseDebanding

C#
public bool GetUseDebanding();

Возвращает true, если отключение полос включено.

Возвращает bool

GetUseTaabool

# GetUseTaa

C#
public bool GetUseTaa();

Возвращает true, если TAA включен.

Возвращает bool

GetVelocityLayer2 перегрузки

# GetVelocityLayer · 1/2

C#
public Rid GetVelocityLayer(uint layer);

Возвращает указанный слой из текстуры скорости, в которую мы визуализируем 3D-контент.

Параметры
Имя	Тип	По умолчанию
`layer`	`uint`	—

Возвращает Rid

# GetVelocityLayer · 2/2

C#
public Rid GetVelocityLayer(uint layer, bool msaa = false);

Возвращает указанный слой из текстуры скорости, в которую мы визуализируем 3D-контент.

Параметры
Имя	Тип	По умолчанию
`layer`	`uint`	—
`msaa`	`bool`	`false`

Возвращает Rid

GetVelocityTexture2 перегрузки

# GetVelocityTexture · 1/2

C#
public Rid GetVelocityTexture();

Возвращает текстуру скорости, в которую мы визуализируем 3D-контент. Если используется multiview, это будет массив текстур со всеми представлениями. Если msaa равен true и включен MSAA, возвращается вариант MSAA буфера.

Возвращает Rid

# GetVelocityTexture · 2/2

C#
public Rid GetVelocityTexture(bool msaa = false);

Параметры
Имя	Тип	По умолчанию
`msaa`	`bool`	`false`

Возвращает Rid

GetViewCountuint

# GetViewCount

C#
public uint GetViewCount();

Возвращает количество просмотров для соответствующего окна просмотра.

Возвращает uint

HasTexturebool

# HasTexture

C#
public bool HasTexture(StringName context, StringName name);

Возвращает true, если для этого имени существует кэшированная текстура.

Параметры
Имя	Тип	По умолчанию
`context`	`StringName`	—
`name`	`StringName`	—

Возвращает bool