Class Buffer.Constant

Namespace

Stride.Graphics

Assembly

Stride.Graphics.dll

Helper methods for creating Constant Buffers.

public static class Buffer.Constant

Inheritance

object

Buffer.Constant

Remarks

A Constant Buffer is a Buffer that is used to pass shader constants / parameters to shaders. They have fast access due to special hardware optimizations, being read-only to shaders, and being of a limited size (64 kB usually).

Methods

New(GraphicsDevice, DataPointer, GraphicsResourceUsage)

Creates a new Constant Buffer with initial data.

[Obsolete("This method is obsolete. Use the span-based methods instead")]
public static Buffer New(GraphicsDevice device, DataPointer dataPointer, GraphicsResourceUsage usage = GraphicsResourceUsage.Dynamic)

Parameters

device GraphicsDevice

The GraphicsDevice.

dataPointer DataPointer

The data pointer to the data to initialize the Constant Buffer.

usage GraphicsResourceUsage

The usage for the Buffer, which determines who can read/write data. By default, it is Dynamic.

Returns

Buffer

A new instance of Buffer.

New(GraphicsDevice, int, GraphicsResourceUsage)

Creates a new Constant Buffer of a given size.

public static Buffer New(GraphicsDevice device, int bufferSize, GraphicsResourceUsage usage = GraphicsResourceUsage.Dynamic)

Parameters

device GraphicsDevice

The GraphicsDevice.

bufferSize int

Size of the Buffer in bytes.

usage GraphicsResourceUsage

The usage for the Buffer, which determines who can read/write data. By default, it is Dynamic.

Returns

Buffer

A new instance of Buffer.

New(GraphicsDevice, ReadOnlySpan<byte>, GraphicsResourceUsage)

Creates a new Constant Buffer with initial data.

public static Buffer New(GraphicsDevice device, ReadOnlySpan<byte> data, GraphicsResourceUsage usage = GraphicsResourceUsage.Dynamic)

Parameters

device GraphicsDevice

The GraphicsDevice.

data ReadOnlySpan<byte>

The data to initialize the Constant Buffer.

usage GraphicsResourceUsage

The usage for the Buffer, which determines who can read/write data. By default, it is Dynamic.

Returns

Buffer

A new instance of Buffer.

New<T>(GraphicsDevice)

Creates a new Constant Buffer with Dynamic usage.

public static Buffer<T> New<T>(GraphicsDevice device) where T : unmanaged

Parameters

device GraphicsDevice

The GraphicsDevice.

Returns

Buffer<T>

A new instance of Buffer.

Type Parameters

T

Type of the data stored in the Buffer.

New<T>(GraphicsDevice, ref readonly T, GraphicsResourceUsage)

Creates a new Constant Buffer with initial data.

public static Buffer<T> New<T>(GraphicsDevice device, ref readonly T value, GraphicsResourceUsage usage = GraphicsResourceUsage.Dynamic) where T : unmanaged

Parameters

device GraphicsDevice

The GraphicsDevice.

value T

The value to initialize the Constant Buffer.

usage GraphicsResourceUsage

The usage for the Buffer, which determines who can read/write data. By default, it is Dynamic.

Returns

Buffer<T>

A new instance of Buffer.

Type Parameters

T

Type of the data stored in the Buffer.

New<T>(GraphicsDevice, T[], GraphicsResourceUsage)

Creates a new Constant Buffer with initial data.

public static Buffer<T> New<T>(GraphicsDevice device, T[] data, GraphicsResourceUsage usage = GraphicsResourceUsage.Dynamic) where T : unmanaged

Parameters

device GraphicsDevice

The GraphicsDevice.

data T[]

The data to initialize the Constant Buffer.

usage GraphicsResourceUsage

The usage for the Buffer, which determines who can read/write data. By default, it is Dynamic.

Returns

Buffer<T>

A new instance of Buffer.

Type Parameters

T

Type of the data stored in the Buffer.

See Also

Buffer

Buffer<T>