SpriteEntry Union Reference

A bitfield of sprite attribute goodness...ugly to look at but not so bad to use. More...

#include <sprite.h>

---

Detailed Description

A bitfield of sprite attribute goodness...ugly to look at but not so bad to use.

Examples:

capture/ScreenShot/source/main.cpp, Graphics/Sprites/fire_and_sprites/source/main.cpp, and input/Touch_Pad/touch_test/source/main.c.

---

Field Documentation

ObjBlendMode SpriteEntry::blendMode

Sprite object mode.

ObjColMode SpriteEntry::colorMode

Sprite color mode.

u16 SpriteEntry::gfxIndex

Upper-left tile index.

bool SpriteEntry::hFlip

Flip sprite horizontally (isRotoscale cleared).

bool SpriteEntry::isHidden

Sprite is hidden (isRotoscale cleared).

bool SpriteEntry::isMosaic

Enables mosaic effect if set.

bool SpriteEntry::isRotateScale

Sprite uses affine parameters if set.

bool SpriteEntry::isSizeDouble

Sprite bounds is doubled (isRotoscale set).

u8 SpriteEntry::palette

Sprite palette to use in paletted color modes.

ObjPriority SpriteEntry::priority

Sprite priority.

u8 SpriteEntry::rotationIndex

Affine parameter number to use (isRotoscale set).

ObjShape SpriteEntry::shape

Sprite shape.

ObjSize SpriteEntry::size

Sprite size.

bool SpriteEntry::vFlip

Flip sprite vertically (isRotoscale cleared).

u16 SpriteEntry::x

Sprite X position.

u16 SpriteEntry::y

Sprite Y position.

---

The documentation for this union was generated from the following file:

• sprite.h