Table of Contents

Struct DataBox

Namespace
Stride.Graphics
Assembly
Stride.dll

Defines a region of data organized in 3D.

public struct DataBox : IEquatable<DataBox>
Implements
Inherited Members
Extension Methods

Constructors

DataBox(nint, int, int)

Defines a region of data organized in 3D.

public DataBox(nint dataPointer, int rowPitch, int slicePitch)

Parameters

dataPointer nint

A pointer to the data.

rowPitch int

The number of bytes per row of the data.

slicePitch int

The number of bytes per slice of the data (for a 3D Texture, a slice is a 2D image).

Fields

DataPointer

A pointer to the data.

public nint DataPointer

Field Value

nint

Empty

An empty DataBox.

public static readonly DataBox Empty

Field Value

DataBox

RowPitch

The number of bytes per row of the data.

public int RowPitch

Field Value

int

SlicePitch

The number of bytes per slice of the data (for a 3D Texture, a slice is a 2D image).

public int SlicePitch

Field Value

int

Properties

IsEmpty

Gets a value indicating whether this data box is empty.

public readonly bool IsEmpty { get; }

Property Value

bool

true if this instance is empty; otherwise, false.

Methods

Equals(DataBox)

Indicates whether the current object is equal to another object of the same type.

public readonly bool Equals(DataBox other)

Parameters

other DataBox

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Indicates whether this instance and a specified object are equal.

public override readonly bool Equals(object obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override readonly int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

Operators

operator ==(DataBox, DataBox)

public static bool operator ==(DataBox left, DataBox right)

Parameters

left DataBox
right DataBox

Returns

bool

operator !=(DataBox, DataBox)

public static bool operator !=(DataBox left, DataBox right)

Parameters

left DataBox
right DataBox

Returns

bool