Class Buffer<T>

Namespace

Stride.Graphics

Assembly

Stride.Graphics.dll

A buffer with typed information.

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

Type Parameters

T

Type of an element of this 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.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.SetData<TData>(CommandList, ref TData, int)

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

Buffer.GetData(CommandList, Buffer, DataPointer)

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

Buffer.SetData(CommandList, DataPointer, int)

Buffer.SetData<T>(CommandList, ReadOnlySpan<T>, 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 T, BufferFlags, GraphicsResourceUsage)

Buffer.New<T>(GraphicsDevice, ref 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.InitializeFromImpl(BufferDescription, BufferFlags, PixelFormat, nint)

Buffer.OnDestroyed()

Buffer.OnRecreate()

Buffer.Recreate(nint)

Buffer.OnNameChanged()

GraphicsResource.IsDebugMode

GraphicsResource.NativeShaderResourceView

GraphicsResource.NativeUnorderedAccessView

GraphicsResourceBase.NativeResource

GraphicsResourceBase.NativeDeviceChild

GraphicsResourceBase.NativeDevice

GraphicsResourceBase.Reload

GraphicsResourceBase.GraphicsDevice

GraphicsResourceBase.Destroyed

GraphicsResourceBase.OnPause()

GraphicsResourceBase.OnResume()

GraphicsResourceBase.Destroy()

ComponentBase.Tags

ComponentBase.Name

ComponentBase.ToString()

DisposeBase.Dispose()

DisposeBase.IsDisposed

DisposeBase.OnAddReference()

DisposeBase.OnReleaseReference()

Extension Methods

GraphicsSerializerExtensions.GetSerializationData(Buffer)

GraphicsSerializerExtensions.SetSerializationData(Buffer, BufferData)

ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)

ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)

Constructors

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

protected Buffer(GraphicsDevice device, BufferDescription description, BufferFlags viewFlags, PixelFormat viewFormat, nint dataPointer)

Parameters

device GraphicsDevice

description BufferDescription

viewFlags BufferFlags

viewFormat PixelFormat

dataPointer nint

Fields

ElementSize

Gets the size of element T.

public readonly int ElementSize

Field Value

int

Methods

GetData(CommandList)

Gets the content of this texture to an array of data.

public T[] GetData(CommandList commandList)

Parameters

commandList CommandList

Returns

T[]

An array of data.

Remarks

This method is only working when called from the main thread that is accessing the main GraphicsDevice. This method creates internally a stagging resource if this texture is not already a stagging resouce, copies to it and map it to memory. Use method with explicit staging resource for optimal performances.

SetData(CommandList, ref T, int)

Copies the content of a single structure data from CPU memory to this buffer into GPU memory.

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

Parameters

commandList CommandList

fromData T

The data to copy from.

offsetInBytes int

The offset in bytes to write to.

Remarks

This method is only working when called from the main thread that is accessing the main GraphicsDevice. See the unmanaged documentation about Map/UnMap for usage and restrictions.

Exceptions

ArgumentException

SetData(CommandList, T[], int)

Copies the content an array of data from CPU memory to this buffer into GPU memory.

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

Parameters

commandList CommandList

fromData T[]

The data to copy from.

offsetInBytes int

The offset in bytes to write to.

Remarks

This method is only working when called from the main thread that is accessing the main GraphicsDevice. See the unmanaged documentation about Map/UnMap for usage and restrictions.