Class Buffer<T>

Namespace

Stride.Graphics

Assembly

Stride.Graphics.dll

All-in-one GPU buffer that is able to represent many types of Buffers (shader Constant Buffers, Structured Buffers, Raw Buffers, Argument Buffers, etc.), but with typed information.

public class Buffer<T> : Buffer, IDisposable, IComponent, IReferencable, ICollectorHolder where T : unmanaged

Type Parameters

T

The type of the elements of the Buffer.

Inheritance

object

DisposeBase

ComponentBase

GraphicsResourceBase

GraphicsResource

Buffer

Buffer<T>

Implements

IDisposable

IComponent

IReferencable

ICollectorHolder

Inherited Members

Buffer.elementCount

Buffer.Description

Buffer.Usage

Buffer.Flags

Buffer.SizeInBytes

Buffer.StructureByteStride

Buffer.ElementCount

Buffer.ViewFlags

Buffer.ViewFormat

Buffer.InitialCounterOffset

Buffer.ToStaging()

Buffer.Clone()

Buffer.InitializeFromImpl(ref readonly BufferDescription, BufferFlags, PixelFormat, nint)

Buffer.GetData<TData>(CommandList)

Buffer.GetData<TData>(CommandList, TData[])

Buffer.GetData<TData>(CommandList, ref TData)

Buffer.GetData<TData>(CommandList, Buffer, ref TData)

Buffer.GetData<TData>(CommandList, Buffer, TData[])

Buffer.GetData(CommandList, Buffer, DataPointer)

Buffer.GetData<TData>(CommandList, Buffer, Span<TData>)

Buffer.SetData<TData>(CommandList, ref readonly TData, int)

Buffer.SetData<TData>(CommandList, TData[], int)

Buffer.SetData(CommandList, DataPointer, int)

Buffer.SetData<TData>(CommandList, ReadOnlySpan<TData>, int)

Buffer.New(GraphicsDevice, BufferDescription, PixelFormat)

Buffer.New(GraphicsDevice, int, BufferFlags, GraphicsResourceUsage)

Buffer.New<T>(GraphicsDevice, int, BufferFlags, GraphicsResourceUsage)

Buffer.New(GraphicsDevice, int, BufferFlags, PixelFormat, GraphicsResourceUsage)

Buffer.New(GraphicsDevice, int, int, BufferFlags, GraphicsResourceUsage)

Buffer.New(GraphicsDevice, int, int, BufferFlags, PixelFormat, GraphicsResourceUsage)

Buffer.New<T>(GraphicsDevice, ref readonly T, BufferFlags, GraphicsResourceUsage)

Buffer.New<T>(GraphicsDevice, ref readonly T, BufferFlags, PixelFormat, GraphicsResourceUsage)

Buffer.New<T>(GraphicsDevice, T[], BufferFlags, GraphicsResourceUsage)

Buffer.New<T>(GraphicsDevice, T[], BufferFlags, PixelFormat, GraphicsResourceUsage)

Buffer.New<T>(GraphicsDevice, ReadOnlySpan<T>, BufferFlags, PixelFormat, GraphicsResourceUsage)

Buffer.New(GraphicsDevice, ReadOnlySpan<byte>, int, BufferFlags, PixelFormat, GraphicsResourceUsage)

Buffer.New(GraphicsDevice, DataPointer, int, BufferFlags, GraphicsResourceUsage)

Buffer.New(GraphicsDevice, DataPointer, int, BufferFlags, PixelFormat, GraphicsResourceUsage)

Buffer.RecreateWith<T>(T[])

Buffer.RecreateWith(nint)

Buffer.Recreate<T>(T[])

Buffer.OnDestroyed(bool)

Buffer.OnRecreate()

Buffer.Recreate(nint)

Buffer.OnNameChanged()

GraphicsResource.NativeShaderResourceView

GraphicsResource.NativeUnorderedAccessView

GraphicsResourceBase.NativeResource

GraphicsResourceBase.NativeDeviceChild

GraphicsResourceBase.UnsetNativeDeviceChild()

GraphicsResourceBase.SetNativeDeviceChild(ComPtr<ID3D11DeviceChild>)

GraphicsResourceBase.NativeDevice

GraphicsResourceBase.IsDebugMode

GraphicsResourceBase.Reload

GraphicsResourceBase.GraphicsDevice

GraphicsResourceBase.Destroyed

GraphicsResourceBase.OnPause()

GraphicsResourceBase.OnResume()

GraphicsResourceBase.Destroy()

ComponentBase.Tags

ComponentBase.Name

ComponentBase.ToString()

DisposeBase.IsDisposed

DisposeBase.Dispose()

DisposeBase.OnAddReference()

DisposeBase.OnReleaseReference()

Extension Methods

GraphicsSerializerExtensions.GetSerializationData(Buffer)

GraphicsSerializerExtensions.SetSerializationData(Buffer, BufferData)

ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)

ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)

UnsafeUtilities.As<T>(object?)

Remarks

Buffer<T> constains static methods for creating new Buffers with typed information by specifying all their characteristics.

Also look for the following static methods that aid in the creation of specific kinds of Buffers: Buffer.Argument (for Argument Buffers), Buffer.Constant (for Constant Buffers), Buffer.Index (for Index Buffers), Buffer.Raw (for Raw Buffers), Buffer.Structured (for Structured Buffers), Buffer.Typed (for Typed Buffers), and Buffer.Vertex (for Vertex Buffers).

You can also check the methods of Buffer for creating Buffers with the maximum flexibility.

Consult the documentation of your graphics API for more information on each kind of Buffer.

Constructors

Buffer(GraphicsDevice, BufferDescription, BufferFlags, PixelFormat, nint, string?)

Initializes a new instance of typed Buffer<T>.

protected Buffer(GraphicsDevice device, BufferDescription description, BufferFlags bufferFlags, PixelFormat viewFormat, nint dataPointer, string? name = null)

Parameters

device GraphicsDevice

The GraphicsDevice.

description BufferDescription

The description of the Buffer's characteristics.

bufferFlags BufferFlags

The buffer flags to specify the type of Buffer.

viewFormat PixelFormat

View format used if the Buffer is used as a Shader Resource View, or None if not.

dataPointer nint

The data pointer to the initial data the Buffer will contain.

name string

A name for the Buffer, used for debugging purposes. Specify null to not set a name and use the name of the type instead.

Fields

ElementSize

The size of the elements in this Buffer<T> (i.e. the size of T).

public readonly int ElementSize

Field Value

int

Methods

GetData(CommandList)

Gets the contents of the Buffer as an array of data.

public T[] GetData(CommandList commandList)

Parameters

commandList CommandList

The CommandList.

Returns

T[]

An array of data with the contents of the Buffer.

Remarks

This method only works when called from the main thread that is accessing the main GraphicsDevice.

This method creates internally a staging resource (if this Buffer is not already a staging resource), copies to it and map it to memory. Use a method that allows to specify an explicit staging resource for optimal performance.

SetData(CommandList, ref readonly T, int)

Copies the contents an array of data on CPU memory into the Buffer in GPU memory.

public void SetData(CommandList commandList, ref readonly T fromData, int offsetInBytes = 0)

Parameters

commandList CommandList

The CommandList.

fromData T

The data to copy from.

offsetInBytes int

The offset in bytes to write to.

Remarks

See MapSubResource(GraphicsResource, int, MapMode, bool, int, int) and UpdateSubResource(GraphicsResource, int, DataBox, ResourceRegion) for more information about usage and restrictions.

Exceptions

ArgumentException

offsetInBytes is only supported for Buffers declared with Default.

SetData(CommandList, T[], int)

Copies the contents of an array of data on CPU memory into the Buffer in GPU memory.

public void SetData(CommandList commandList, T[] fromData, int offsetInBytes = 0)

Parameters

commandList CommandList

The CommandList.

fromData T[]

The array of data to copy from.

offsetInBytes int

The offset in bytes from the start of the Buffer where data is to be written.

Remarks

See MapSubResource(GraphicsResource, int, MapMode, bool, int, int) and UpdateSubResource(GraphicsResource, int, DataBox, ResourceRegion) for more information about usage and restrictions.

Exceptions

ArgumentException

offsetInBytes is only supported for Buffers declared with Default.

See Also

Buffer

Buffer.Argument

Buffer.Constant

Buffer.Index

Buffer.Raw

Buffer.Structured

Buffer.Typed

Buffer.Vertex