Struct BufferCreateInfo

Namespace

ReFuel.Resources

Assembly

ReFuel.dll

Create info for BufferResource entities.

public readonly record struct BufferCreateInfo : IEquatable<BufferCreateInfo>

Implements

IEquatable<BufferCreateInfo>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

BufferCreateInfo(BufferMode, IBufferProvider, bool)

public BufferCreateInfo(BufferMode mode, IBufferProvider provider, bool copy = false)

Parameters

mode BufferMode

provider IBufferProvider

copy bool

BufferCreateInfo(BufferMode, int)

public BufferCreateInfo(BufferMode mode, int initialSize)

Parameters

mode BufferMode

initialSize int

Properties

Copy

If true, the buffer Source is copied.

public bool Copy { get; }

Property Value

bool

InitialSize

Initial size of the buffer, in bytes.

public int InitialSize { get; }

Property Value

int

Mode

Buffer mode value.

public BufferMode Mode { get; }

Property Value

BufferMode

Source

The buffer to source data from.

public IBufferProvider? Source { get; }

Property Value

IBufferProvider

Methods

Create<T>(BufferMode, int, T?)

Create a buffer with an empty array.

public static BufferCreateInfo Create<T>(BufferMode mode, int capacity, T? initialze = null) where T : struct

Parameters

mode BufferMode

The buffer mode.

capacity int

Capacity of the buffer in elements.

initialze T?

The value to initialize to.

Returns

BufferCreateInfo

A BufferCreateInfo struct for this new array.

Type Parameters

T

The array value type.

Create<T>(BufferMode, T[], bool)

Create a buffer with the given array.

public static BufferCreateInfo Create<T>(BufferMode mode, T[] array, bool copy = false) where T : struct

Parameters

mode BufferMode

The buffer mode.

array T[]

The array to create the buffer with.

copy bool

True to copy the given buffer to the hardware buffer immediately.

Returns

BufferCreateInfo

A BufferCreateInfo struct for this new array.

Type Parameters

T

The array value type.