orx
1.11
Portable Game Engine
|
Typedefs | |
typedef struct __orxGRAPHIC_t | orxGRAPHIC |
Graphic Module. Allows to creates and handle 2D/3D Graphics. They are used as texture/animation container, with associated properties. 2D Graphics are used by objects. They thus can be referenced by objects as structures.
#define orxGRAPHIC_KU32_FLAG_2D 0x00000001 |
2D type graphic flag
Definition at line 60 of file orxGraphic.h.
#define orxGRAPHIC_KU32_FLAG_ALIGN_BOTTOM 0x00000080 |
Bottom vertical alignment
Definition at line 73 of file orxGraphic.h.
#define orxGRAPHIC_KU32_FLAG_ALIGN_CENTER 0x00000000 |
Center vertical / horizontal alignment
Definition at line 69 of file orxGraphic.h.
#define orxGRAPHIC_KU32_FLAG_ALIGN_LEFT 0x00000010 |
Left horizontal alignment
Definition at line 70 of file orxGraphic.h.
#define orxGRAPHIC_KU32_FLAG_ALIGN_RIGHT 0x00000020 |
Right horizontal alignment
Definition at line 71 of file orxGraphic.h.
#define orxGRAPHIC_KU32_FLAG_ALIGN_ROUND 0x00000200 |
Round alignment value
Definition at line 75 of file orxGraphic.h.
#define orxGRAPHIC_KU32_FLAG_ALIGN_TOP 0x00000040 |
Top vertical alignment
Definition at line 72 of file orxGraphic.h.
#define orxGRAPHIC_KU32_FLAG_ALIGN_TRUNCATE 0x00000100 |
Truncate alignment value
Definition at line 74 of file orxGraphic.h.
#define orxGRAPHIC_KU32_FLAG_FLIP_X 0x00000004 |
X axis flipping flag
Definition at line 65 of file orxGraphic.h.
#define orxGRAPHIC_KU32_FLAG_FLIP_Y 0x00000008 |
Y axis flipping flag
Definition at line 66 of file orxGraphic.h.
#define orxGRAPHIC_KU32_FLAG_NONE 0x00000000 |
Graphic flagsNo flags
Definition at line 58 of file orxGraphic.h.
#define orxGRAPHIC_KU32_FLAG_TEXT 0x00000002 |
Text type graphic flag
Definition at line 61 of file orxGraphic.h.
#define orxGRAPHIC_KU32_MASK_FLIP_BOTH 0x0000000C |
Both axis flipping mask
Definition at line 67 of file orxGraphic.h.
#define orxGRAPHIC_KU32_MASK_TYPE 0x00000003 |
Type mask
Definition at line 63 of file orxGraphic.h.
#define orxGRAPHIC_KU32_MASK_USER_ALL 0x00000FFF |
User all ID mask
Definition at line 77 of file orxGraphic.h.
#define orxGRAPHIC_KZ_CONFIG_ALPHA "Alpha" |
Definition at line 88 of file orxGraphic.h.
#define orxGRAPHIC_KZ_CONFIG_BLEND_MODE "BlendMode" |
Definition at line 95 of file orxGraphic.h.
#define orxGRAPHIC_KZ_CONFIG_COLOR "Color" |
Definition at line 87 of file orxGraphic.h.
#define orxGRAPHIC_KZ_CONFIG_FLIP "Flip" |
Definition at line 92 of file orxGraphic.h.
#define orxGRAPHIC_KZ_CONFIG_HSL "HSL" |
Definition at line 90 of file orxGraphic.h.
#define orxGRAPHIC_KZ_CONFIG_HSV "HSV" |
Definition at line 91 of file orxGraphic.h.
#define orxGRAPHIC_KZ_CONFIG_KEEP_IN_CACHE "KeepInCache" |
Definition at line 96 of file orxGraphic.h.
#define orxGRAPHIC_KZ_CONFIG_PIVOT "Pivot" |
Definition at line 86 of file orxGraphic.h.
#define orxGRAPHIC_KZ_CONFIG_REPEAT "Repeat" |
Definition at line 93 of file orxGraphic.h.
#define orxGRAPHIC_KZ_CONFIG_RGB "RGB" |
Definition at line 89 of file orxGraphic.h.
#define orxGRAPHIC_KZ_CONFIG_SMOOTHING "Smoothing" |
Definition at line 94 of file orxGraphic.h.
#define orxGRAPHIC_KZ_CONFIG_TEXT_NAME "Text" |
Definition at line 85 of file orxGraphic.h.
#define orxGRAPHIC_KZ_CONFIG_TEXTURE_NAME "Texture" |
Misc defines
Definition at line 82 of file orxGraphic.h.
#define orxGRAPHIC_KZ_CONFIG_TEXTURE_ORIGIN "TextureOrigin" |
Definition at line 83 of file orxGraphic.h.
#define orxGRAPHIC_KZ_CONFIG_TEXTURE_SIZE "TextureSize" |
Definition at line 84 of file orxGraphic.h.
typedef struct __orxGRAPHIC_t orxGRAPHIC |
Internal Graphic structure
Definition at line 101 of file orxGraphic.h.
orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_ClearBlendMode | ( | orxGRAPHIC * | _pstGraphic | ) |
Clears graphic blend mode
[in] | _pstGraphic | Concerned graphic |
orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_ClearColor | ( | orxGRAPHIC * | _pstGraphic | ) |
Clears graphic color
[in] | _pstGraphic | Concerned graphic |
orxDLLAPI orxGRAPHIC* orxFASTCALL orxGraphic_Create | ( | ) |
Creates an empty graphic
orxDLLAPI orxGRAPHIC* orxFASTCALL orxGraphic_CreateFromConfig | ( | const orxSTRING | _zConfigID | ) |
Creates a graphic from config
[in] | _zConfigID | Config ID @ return orxGRAPHIC / orxNULL |
orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_Delete | ( | orxGRAPHIC * | _pstGraphic | ) |
Deletes a graphic
[in] | _pstGraphic | Graphic to delete |
orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL orxGraphic_GetBlendMode | ( | const orxGRAPHIC * | _pstGraphic | ) |
Gets graphic blend mode
[in] | _pstGraphic | Concerned graphic |
orxDLLAPI orxCOLOR* orxFASTCALL orxGraphic_GetColor | ( | const orxGRAPHIC * | _pstGraphic, |
orxCOLOR * | _pstColor | ||
) |
Gets graphic color
[in] | _pstGraphic | Concerned graphic |
[out] | _pstColor | Object's color |
orxDLLAPI orxSTRUCTURE* orxFASTCALL orxGraphic_GetData | ( | const orxGRAPHIC * | _pstGraphic | ) |
Gets graphic data
[in] | _pstGraphic | Concerned graphic |
orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_GetFlip | ( | const orxGRAPHIC * | _pstGraphic, |
orxBOOL * | _pbFlipX, | ||
orxBOOL * | _pbFlipY | ||
) |
Gets graphic flipping
[in] | _pstGraphic | Concerned graphic |
[in] | _pbFlipX | X axis flipping |
[in] | _pbFlipY | Y axis flipping |
orxDLLAPI const orxSTRING orxFASTCALL orxGraphic_GetName | ( | const orxGRAPHIC * | _pstGraphic | ) |
Gets graphic config name
[in] | _pstGraphic | Concerned graphic |
orxDLLAPI orxVECTOR* orxFASTCALL orxGraphic_GetOrigin | ( | const orxGRAPHIC * | _pstGraphic, |
orxVECTOR * | _pvOrigin | ||
) |
Gets graphic origin
[in] | _pstGraphic | Concerned graphic |
[out] | _pvOrigin | Origin coordinates |
orxDLLAPI orxVECTOR* orxFASTCALL orxGraphic_GetPivot | ( | const orxGRAPHIC * | _pstGraphic, |
orxVECTOR * | _pvPivot | ||
) |
Gets graphic pivot
[in] | _pstGraphic | Concerned graphic |
[out] | _pvPivot | Graphic pivot |
orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_GetRepeat | ( | const orxGRAPHIC * | _pstGraphic, |
orxFLOAT * | _pfRepeatX, | ||
orxFLOAT * | _pfRepeatY | ||
) |
Gets graphic repeat (wrap) values
[in] | _pstGraphic | Concerned graphic |
[out] | _pfRepeatX | X-axis repeat value |
[out] | _pfRepeatY | Y-axis repeat value |
orxDLLAPI orxVECTOR* orxFASTCALL orxGraphic_GetSize | ( | const orxGRAPHIC * | _pstGraphic, |
orxVECTOR * | _pvSize | ||
) |
Gets graphic size
[in] | _pstGraphic | Concerned graphic |
[out] | _pvSize | Object's size |
orxDLLAPI orxDISPLAY_SMOOTHING orxFASTCALL orxGraphic_GetSmoothing | ( | const orxGRAPHIC * | _pstGraphic | ) |
Gets graphic smoothing
[in] | _pstGraphic | Concerned graphic |
orxDLLAPI orxBOOL orxFASTCALL orxGraphic_HasBlendMode | ( | const orxGRAPHIC * | _pstGraphic | ) |
Graphic has blend mode accessor
[in] | _pstGraphic | Concerned graphic |
orxDLLAPI orxBOOL orxFASTCALL orxGraphic_HasColor | ( | const orxGRAPHIC * | _pstGraphic | ) |
Graphic has color accessor
[in] | _pstGraphic | Concerned graphic |
orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetBlendMode | ( | orxGRAPHIC * | _pstGraphic, |
orxDISPLAY_BLEND_MODE | _eBlendMode | ||
) |
Sets object blend mode
[in] | _pstGraphic | Concerned graphic |
[in] | _eBlendMode | Blend mode (alpha, multiply, add or none) |
orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetColor | ( | orxGRAPHIC * | _pstGraphic, |
const orxCOLOR * | _pstColor | ||
) |
Sets graphic color
[in] | _pstGraphic | Concerned graphic |
[in] | _pstColor | Color to set |
orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetData | ( | orxGRAPHIC * | _pstGraphic, |
orxSTRUCTURE * | _pstData | ||
) |
Sets graphic data
[in] | _pstGraphic | Concerned graphic |
[in] | _pstData | Data structure to set / orxNULL |
orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetFlip | ( | orxGRAPHIC * | _pstGraphic, |
orxBOOL | _bFlipX, | ||
orxBOOL | _bFlipY | ||
) |
Sets graphic flipping
[in] | _pstGraphic | Concerned graphic |
[in] | _bFlipX | Flip it on X axis |
[in] | _bFlipY | Flip it on Y axis |
orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetOrigin | ( | orxGRAPHIC * | _pstGraphic, |
const orxVECTOR * | _pvOrigin | ||
) |
Sets graphic origin
[in] | _pstGraphic | Concerned graphic |
[in] | _pvOrigin | Origin coordinates |
orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetPivot | ( | orxGRAPHIC * | _pstGraphic, |
const orxVECTOR * | _pvPivot | ||
) |
Sets graphic pivot
[in] | _pstGraphic | Concerned graphic |
[in] | _pvPivot | Pivot to set |
orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetRelativePivot | ( | orxGRAPHIC * | _pstGraphic, |
orxU32 | _u32AlignFlags | ||
) |
Sets relative graphic pivot
[in] | _pstGraphic | Concerned graphic |
[in] | _u32AlignFlags | Alignment flags |
orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetRepeat | ( | orxGRAPHIC * | _pstGraphic, |
orxFLOAT | _fRepeatX, | ||
orxFLOAT | _fRepeatY | ||
) |
Sets graphic repeat (wrap) value
[in] | _pstGraphic | Concerned graphic |
[in] | _fRepeatX | X-axis repeat value |
[in] | _fRepeatY | Y-axis repeat value |
orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetSize | ( | orxGRAPHIC * | _pstGraphic, |
const orxVECTOR * | _pvSize | ||
) |
Sets graphic size
[in] | _pstGraphic | Concerned graphic |
[in] | _pvSize | Size to set |
orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetSmoothing | ( | orxGRAPHIC * | _pstGraphic, |
orxDISPLAY_SMOOTHING | _eSmoothing | ||
) |
Sets graphic smoothing
[in] | _pstGraphic | Concerned graphic |
[in] | _eSmoothing | Smoothing type (enabled, default or none) |
orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_UpdateSize | ( | orxGRAPHIC * | _pstGraphic | ) |
Updates graphic size (recompute)
[in] | _pstGraphic | Concerned graphic |