Struct ResourceRegion

Namespace

Stride.Graphics

Assembly

Stride.Graphics.dll

Defines a 3D box with integer coordinates, represented as the coordinates of its minimum (left, top, front) and maximum (right, bottom, back) corners.

public struct ResourceRegion

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

Extension Methods

UnsafeUtilities.AsPointer<T>(ref T)

UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom)

UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int)

UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom)

UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int)

UnsafeUtilities.As<TFrom, TTo>(ref TFrom)

UnsafeUtilities.BitCast<TFrom, TTo>(TFrom)

UnsafeUtilities.As<T>(object?)

Remarks

The values for Right, Bottom, and Back are each one pixel past the end of the pixels that are included in the box region.

That is, the values for Left, Top, and Front are included in the box region while the values for Right, Bottom, and Back are excluded from the box region.

For example, for a box that is one pixel wide, where (Right - Left) == 1, the box region includes the left pixel but not the right pixel.

Constructors

ResourceRegion(int, int, int, int, int, int)

Defines a 3D box with integer coordinates, represented as the coordinates of its minimum (left, top, front) and maximum (right, bottom, back) corners.

public ResourceRegion(int left, int top, int front, int right, int bottom, int back)

Parameters

left int

The X position of the left hand side of the box.

top int

The Y position of the top of the box.

front int

The Z position of the front of the box.

right int

The X position of the right hand side of the box.

bottom int

The Y position of the bottom of the box.

back int

The Z position of the back of the box.

Remarks

The values for Right, Bottom, and Back are each one pixel past the end of the pixels that are included in the box region.

That is, the values for Left, Top, and Front are included in the box region while the values for Right, Bottom, and Back are excluded from the box region.

For example, for a box that is one pixel wide, where (Right - Left) == 1, the box region includes the left pixel but not the right pixel.

Fields

Back

The Z position of the back of the box.

public int Back

Field Value

int

Bottom

The Y position of the bottom of the box.

public int Bottom

Field Value

int

Front

The Z position of the front of the box.

public int Front

Field Value

int

Left

The X position of the left hand side of the box.

public int Left

Field Value

int

Right

The X position of the right hand side of the box.

public int Right

Field Value

int

Top

The Y position of the top of the box.

public int Top

Field Value

int

Properties

Depth

Gets the depth of the box (i.e. Back - Front).

public readonly int Depth { get; }

Property Value

int

Height

Gets the height of the box (i.e. Bottom - Top).

public readonly int Height { get; }

Property Value

int

Width

Gets the width of the box (i.e. Right - Left).

public readonly int Width { get; }

Property Value

int