Table of Contents

Class Buffer.Vertex

Namespace
Stride.Graphics
Assembly
Stride.Graphics.dll

Helper methods for creating Vertex Buffers.

public static class Buffer.Vertex
Inheritance
object
Buffer.Vertex

Remarks

A Vertex Buffer is a Buffer that is used as input to the vertex shader stage. They store vertex data for 3D models (positions, normals, UVs, etc.).

Methods

New(GraphicsDevice, DataPointer, GraphicsResourceUsage)

Creates a new Vertex 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.Immutable)

Parameters

device GraphicsDevice

The GraphicsDevice.

dataPointer DataPointer

The data pointer to the data to initialize the Vertex buffer.

usage GraphicsResourceUsage

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

Returns

Buffer

A new instance of Buffer.

New(GraphicsDevice, int, GraphicsResourceUsage, BufferFlags)

Creates a new Vertex Buffer of a given size.

public static Buffer New(GraphicsDevice device, int bufferSize, GraphicsResourceUsage usage = GraphicsResourceUsage.Default, BufferFlags additionalFlags = BufferFlags.None)

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 Default.

additionalFlags BufferFlags

Additional Buffer flags. For example, you can specify StreamOutput to use the Buffer as a Stream Output target.

Returns

Buffer

A new instance of Buffer.

New(GraphicsDevice, ReadOnlySpan<byte>, GraphicsResourceUsage)

Creates a new Vertex Buffer with initial data.

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

Parameters

device GraphicsDevice

The GraphicsDevice.

data ReadOnlySpan<byte>

The data to initialize the Vertex buffer.

usage GraphicsResourceUsage

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

Returns

Buffer

A new instance of Buffer.

New<T>(GraphicsDevice, GraphicsResourceUsage)

Creates a new Vertex Buffer.

public static Buffer<T> New<T>(GraphicsDevice device, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged

Parameters

device GraphicsDevice

The GraphicsDevice.

usage GraphicsResourceUsage

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

Returns

Buffer<T>

A new instance of Buffer.

Type Parameters

T

Type of the data stored in the Buffer.

New<T>(GraphicsDevice, int, GraphicsResourceUsage)

Creates a new Vertex Buffer.

public static Buffer<T> New<T>(GraphicsDevice device, int vertexCount, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged

Parameters

device GraphicsDevice

The GraphicsDevice.

vertexCount int

The number of vertices in this Buffer.

usage GraphicsResourceUsage

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

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 Vertex Buffer with initial data.

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

Parameters

device GraphicsDevice

The GraphicsDevice.

value T

The value to initialize the Vertex buffer.

usage GraphicsResourceUsage

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

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 Vertex Buffer with initial data.

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

Parameters

device GraphicsDevice

The GraphicsDevice.

data T[]

The data to initialize the Vertex buffer.

usage GraphicsResourceUsage

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

Returns

Buffer<T>

A new instance of Buffer.

Type Parameters

T

Type of the data stored in the Buffer.

See Also