struct CubemapFaceCoordsI in Tinman.Terrain.Mapping

Represents a point on a cubemap face with 32-bit integer precision.

struct

CubemapFaceCoordsI

implements

IEquatable<CubemapFaceCoordsI>

Configuration

Config

The configurator object for this type.

public static property	Config { get }
type	IConfigurator<CubemapFaceCoordsI>
value	[not-null]	The configurator object.

Serialization

Serializer

The serialization helper object for values of CubemapFaceCoordsI.

public static readonly field	Serializer
type	ITypeSerializerEx<CubemapFaceCoordsI>

Public / Constants

Undefined

Undefined set of cubemap face coordinates.

public static readonly field	Undefined
type	CubemapFaceCoordsI

See also:

IsUndefined

Zero

Coordinates (0,0) on NegZ.

public static readonly field	Zero
type	CubemapFaceCoordsI

Public / Attributes

Face

The cubemap face.

public readonly field	Face
type	CubemapFace

IsUndefined

Is this an undefined set of cubemap face coordinates?

public property	IsUndefined { get }
type	bool
value		true if the coordinates are undefined, false if not.

See also:

Undefined

X

Cubemap face X-coordinate.

public readonly field	X
type	int32

XY

Returns the face X- and Y-coordinates.

public property	XY { get }
type	Vec2I
value		The coordinates.

Y

Cubemap face Y-coordinate.

public readonly field	Y
type	int32

Public / Constructors

CubemapFaceCoordsI

Creates a new instance of CubemapFaceCoordsD.

public constructor	CubemapFaceCoordsI (int32 x, int32 y, CubemapFace face)
params	x		Cubemap face X-coordinate.
	y		Cubemap face Y-coordinate.
	face		The cubemap face.

Public / Methods

Clip

Clips these coordinates at the given bounds.

public method	Clip (int32 width, int32 height)
type	CubemapFaceCoordsI
params	width	[>0]	Width of clip bounds.
	height	[>0]	Height of clip bounds.
returns			The resulting coordinates.

Equals

public method	Equals (CubemapFaceCoordsI other)
type	bool
params	other

Shift

Shifts the cubemap face coordinates.

[Pure]
public method	Shift (int32 amount)
type	CubemapFaceCoordsI
params	amount		The number of bits to shift leftwards. Specify a negative number for shifting rightwards.
returns			The shifted coordinates.

ToString

[Pure]
public override method	ToString ()
type	string

Wrap

Wraps these coordinates around the cubemap edges if necessary.

public method	Wrap (int32 n)
type	CubemapFaceCoordsI
params	n		Maximum cubemap coordinate.
returns			The resulting coordinates.