Skip to content

GraphicsAPI reference

Struct BufferDescription

Namespace: MicroEngine.Graphics.Devices
Assembly: MicroEngine.Graphics.dll
Guide: The graphics device

A buffer, available on every tier (tier 0: device-owned CPU memory submitted to the backend’s geometry call; tier 1: GPU memory). Contents are written only by UpdateBuffer and are undefined until written.

C#
public readonly struct BufferDescription : IEquatable<BufferDescription>

Implements

IEquatable<BufferDescription>

Constructors

BufferDescription(int, BufferUsage, string?)

A buffer, available on every tier (tier 0: device-owned CPU memory submitted to the backend’s geometry call; tier 1: GPU memory). Contents are written only by UpdateBuffer and are undefined until written.

C#
public BufferDescription(int SizeInBytes, BufferUsage Usage, string? Name = null)

Parameters

SizeInBytes int

Size, at least 1.

Usage BufferUsage

Vertex and/or index.

Name string?

Debug name.

Properties

Name

Debug name.

C#
public string? Name { get; init; }

Property Value

string?

SizeInBytes

Size, at least 1.

C#
public int SizeInBytes { get; init; }

Property Value

int

Usage

Vertex and/or index.

C#
public BufferUsage Usage { get; init; }

Property Value

BufferUsage

Methods

Deconstruct(out int, out BufferUsage, out string?)

C#
public void Deconstruct(out int SizeInBytes, out BufferUsage Usage, out string? Name)

Parameters

SizeInBytes int

Usage BufferUsage

Name string?

Equals(object)

C#
public override bool Equals(object obj)

Parameters

obj object

Returns

bool

Equals(BufferDescription)

C#
public bool Equals(BufferDescription other)

Parameters

other BufferDescription

Returns

bool

GetHashCode()

C#
public override int GetHashCode()

Returns

int

ToString()

C#
public override string ToString()

Returns

string

Operators

operator ==(BufferDescription, BufferDescription)

C#
public static bool operator ==(BufferDescription left, BufferDescription right)

Parameters

left BufferDescription

right BufferDescription

Returns

bool

operator !=(BufferDescription, BufferDescription)

C#
public static bool operator !=(BufferDescription left, BufferDescription right)

Parameters

left BufferDescription

right BufferDescription

Returns

bool