GameAPI.BudgetBoy.SwatchIndex Struct Reference

Structure representing the index of a Swatch in a Palette. More...

Public Member Functions
	SwatchIndex (byte index)
	Constructs a new SwatchIndex pointing to a Swatch at the specified numeric index. More...
	SwatchIndex (Enum index)
	Constructs a new SwatchIndex pointing to a Swatch at the specified numeric index. More...

Static Public Member Functions
static implicit	operator byte (SwatchIndex index)
static implicit	operator SwatchIndex (byte index)
static implicit	operator SwatchIndex (Enum index)

Public Attributes
readonly byte	Value
	The numeric index of a Swatch in the Palette. More...

Static Public Attributes
static readonly SwatchIndex	Black = ReservedSwatches.Black
	The index of a reserved swatch that is completely black. More...
static readonly SwatchIndex	White = ReservedSwatches.White
	The index of a reserved swatch that is completely white. More...
static readonly SwatchIndex	Transparent = ReservedSwatches.Transparent
	The index of a reserved swatch that is completely transparent. More...

Properties
bool	IsReserved [get]
	If true, this index points to a reserved swatch that cannot be overwritten. More...

Detailed Description

Structure representing the index of a Swatch in a Palette.

Constructor & Destructor Documentation

GameAPI.BudgetBoy.SwatchIndex.SwatchIndex ( byte  index )

inline

Constructs a new SwatchIndex pointing to a Swatch at the specified numeric index.

GameAPI.BudgetBoy.SwatchIndex.SwatchIndex ( Enum  index )

inline

Constructs a new SwatchIndex pointing to a Swatch at the specified numeric index.

Member Function Documentation

static implicit GameAPI.BudgetBoy.SwatchIndex.operator byte ( SwatchIndex  index )

inlinestatic

static implicit GameAPI.BudgetBoy.SwatchIndex.operator SwatchIndex ( byte  index )

inlinestatic

static implicit GameAPI.BudgetBoy.SwatchIndex.operator SwatchIndex ( Enum  index )

inlinestatic

Member Data Documentation

readonly SwatchIndex GameAPI.BudgetBoy.SwatchIndex.Black = ReservedSwatches.Black

static

The index of a reserved swatch that is completely black.

readonly SwatchIndex GameAPI.BudgetBoy.SwatchIndex.Transparent = ReservedSwatches.Transparent

static

The index of a reserved swatch that is completely transparent.

readonly byte GameAPI.BudgetBoy.SwatchIndex.Value

The numeric index of a Swatch in the Palette.

readonly SwatchIndex GameAPI.BudgetBoy.SwatchIndex.White = ReservedSwatches.White

static

The index of a reserved swatch that is completely white.

Property Documentation

bool GameAPI.BudgetBoy.SwatchIndex.IsReserved

get

If true, this index points to a reserved swatch that cannot be overwritten.