orx  stable
Portable Game Engine
OrxDecl

Macros

#define __orxLITTLE_ENDIAN__
 
#define __orxX86__
 
#define orxALIGN(ADDRESS, BLOCK_SIZE)    (((size_t)(ADDRESS) + ((size_t)(BLOCK_SIZE) - 1)) & (~((size_t)(BLOCK_SIZE) - 1)))
 
#define orxALIGN16(ADDRESS)    orxALIGN(ADDRESS, 16)
 
#define orxALIGN32(ADDRESS)    orxALIGN(ADDRESS, 32)
 
#define orxALIGN64(ADDRESS)    orxALIGN(ADDRESS, 64)
 
#define orxANSI_KC_MARKER   '\x1b'
 
#define orxANSI_KZ_COLOR_BG_BLACK   "\x1b[40m"
 
#define orxANSI_KZ_COLOR_BG_BLUE   "\x1b[44m"
 
#define orxANSI_KZ_COLOR_BG_CYAN   "\x1b[46m"
 
#define orxANSI_KZ_COLOR_BG_DEFAULT   "\x1b[49m"
 
#define orxANSI_KZ_COLOR_BG_GREEN   "\x1b[42m"
 
#define orxANSI_KZ_COLOR_BG_MAGENTA   "\x1b[45m"
 
#define orxANSI_KZ_COLOR_BG_RED   "\x1b[41m"
 
#define orxANSI_KZ_COLOR_BG_WHITE   "\x1b[47m"
 
#define orxANSI_KZ_COLOR_BG_YELLOW   "\x1b[43m"
 
#define orxANSI_KZ_COLOR_BLINK_OFF   "\x1b[25m"
 
#define orxANSI_KZ_COLOR_BLINK_ON   "\x1b[5m"
 
#define orxANSI_KZ_COLOR_BOLD_OFF   "\x1b[22m"
 
#define orxANSI_KZ_COLOR_BOLD_ON   "\x1b[1m"
 
#define orxANSI_KZ_COLOR_FG_BLACK   "\x1b[30m"
 
#define orxANSI_KZ_COLOR_FG_BLUE   "\x1b[34m"
 
#define orxANSI_KZ_COLOR_FG_CYAN   "\x1b[36m"
 
#define orxANSI_KZ_COLOR_FG_DEFAULT   "\x1b[39m"
 
#define orxANSI_KZ_COLOR_FG_GREEN   "\x1b[32m"
 
#define orxANSI_KZ_COLOR_FG_MAGENTA   "\x1b[35m"
 
#define orxANSI_KZ_COLOR_FG_RED   "\x1b[31m"
 
#define orxANSI_KZ_COLOR_FG_WHITE   "\x1b[37m"
 
#define orxANSI_KZ_COLOR_FG_YELLOW   "\x1b[33m"
 
#define orxANSI_KZ_COLOR_INVERSE_OFF   "\x1b[27m"
 
#define orxANSI_KZ_COLOR_INVERSE_ON   "\x1b[7m"
 
#define orxANSI_KZ_COLOR_ITALICS_OFF   "\x1b[23m"
 
#define orxANSI_KZ_COLOR_ITALICS_ON   "\x1b[3m"
 
#define orxANSI_KZ_COLOR_RESET   "\x1b[0m"
 
#define orxANSI_KZ_COLOR_STRIKETHROUGH_OFF   "\x1b[29m"
 
#define orxANSI_KZ_COLOR_STRIKETHROUGH_ON   "\x1b[9m"
 
#define orxANSI_KZ_COLOR_UNDERLINE_OFF   "\x1b[24m"
 
#define orxANSI_KZ_COLOR_UNDERLINE_ON   "\x1b[4m"
 
#define orxARRAY_GET_ITEM_COUNT(ARRAY)   (sizeof(ARRAY) / sizeof(ARRAY[0]))
 
#define orxDLLAPI   orxIMPORT orxDLLEXPORT /* Compiling orx library => API needs to be exported */
 
#define orxFLAG_GET(X, M)   ((X) & (M))
 
#define orxFLAG_SET(X, A, R)
 
#define orxFLAG_SWAP(X, S)   ((X) ^= (S))
 
#define orxFLAG_TEST(X, F)   (((X) & (F)) != 0)
 
#define orxFLAG_TEST_ALL(X, F)   (((X) & (F)) == (F))
 
#define orxIMPORT
 
#define orxSTRUCT_GET_FROM_FIELD(TYPE, FIELD, POINTER)    ((TYPE *)((orxU8 *)(POINTER) - offsetof(TYPE, FIELD)))
 

Detailed Description

Base declarations

Macro Definition Documentation

#define __orxLITTLE_ENDIAN__

Definition at line 136 of file orxDecl.h.

#define __orxX86__

Definition at line 105 of file orxDecl.h.

#define orxALIGN (   ADDRESS,
  BLOCK_SIZE 
)    (((size_t)(ADDRESS) + ((size_t)(BLOCK_SIZE) - 1)) & (~((size_t)(BLOCK_SIZE) - 1)))

Memory alignment macros

Definition at line 393 of file orxDecl.h.

#define orxALIGN16 (   ADDRESS)    orxALIGN(ADDRESS, 16)

Definition at line 395 of file orxDecl.h.

#define orxALIGN32 (   ADDRESS)    orxALIGN(ADDRESS, 32)

Definition at line 396 of file orxDecl.h.

#define orxALIGN64 (   ADDRESS)    orxALIGN(ADDRESS, 64)

Definition at line 397 of file orxDecl.h.

#define orxANSI_KC_MARKER   '\x1b'

ANSI macros

Definition at line 452 of file orxDecl.h.

#define orxANSI_KZ_COLOR_BG_BLACK   "\x1b[40m"

Definition at line 480 of file orxDecl.h.

#define orxANSI_KZ_COLOR_BG_BLUE   "\x1b[44m"

Definition at line 484 of file orxDecl.h.

#define orxANSI_KZ_COLOR_BG_CYAN   "\x1b[46m"

Definition at line 486 of file orxDecl.h.

#define orxANSI_KZ_COLOR_BG_DEFAULT   "\x1b[49m"

Definition at line 488 of file orxDecl.h.

#define orxANSI_KZ_COLOR_BG_GREEN   "\x1b[42m"

Definition at line 482 of file orxDecl.h.

#define orxANSI_KZ_COLOR_BG_MAGENTA   "\x1b[45m"

Definition at line 485 of file orxDecl.h.

#define orxANSI_KZ_COLOR_BG_RED   "\x1b[41m"

Definition at line 481 of file orxDecl.h.

#define orxANSI_KZ_COLOR_BG_WHITE   "\x1b[47m"

Definition at line 487 of file orxDecl.h.

#define orxANSI_KZ_COLOR_BG_YELLOW   "\x1b[43m"

Definition at line 483 of file orxDecl.h.

#define orxANSI_KZ_COLOR_BLINK_OFF   "\x1b[25m"

Definition at line 466 of file orxDecl.h.

#define orxANSI_KZ_COLOR_BLINK_ON   "\x1b[5m"

Definition at line 459 of file orxDecl.h.

#define orxANSI_KZ_COLOR_BOLD_OFF   "\x1b[22m"

Definition at line 463 of file orxDecl.h.

#define orxANSI_KZ_COLOR_BOLD_ON   "\x1b[1m"

Definition at line 456 of file orxDecl.h.

#define orxANSI_KZ_COLOR_FG_BLACK   "\x1b[30m"

Definition at line 470 of file orxDecl.h.

#define orxANSI_KZ_COLOR_FG_BLUE   "\x1b[34m"

Definition at line 474 of file orxDecl.h.

#define orxANSI_KZ_COLOR_FG_CYAN   "\x1b[36m"

Definition at line 476 of file orxDecl.h.

#define orxANSI_KZ_COLOR_FG_DEFAULT   "\x1b[39m"

Definition at line 478 of file orxDecl.h.

#define orxANSI_KZ_COLOR_FG_GREEN   "\x1b[32m"

Definition at line 472 of file orxDecl.h.

#define orxANSI_KZ_COLOR_FG_MAGENTA   "\x1b[35m"

Definition at line 475 of file orxDecl.h.

#define orxANSI_KZ_COLOR_FG_RED   "\x1b[31m"

Definition at line 471 of file orxDecl.h.

#define orxANSI_KZ_COLOR_FG_WHITE   "\x1b[37m"

Definition at line 477 of file orxDecl.h.

#define orxANSI_KZ_COLOR_FG_YELLOW   "\x1b[33m"

Definition at line 473 of file orxDecl.h.

#define orxANSI_KZ_COLOR_INVERSE_OFF   "\x1b[27m"

Definition at line 467 of file orxDecl.h.

#define orxANSI_KZ_COLOR_INVERSE_ON   "\x1b[7m"

Definition at line 460 of file orxDecl.h.

#define orxANSI_KZ_COLOR_ITALICS_OFF   "\x1b[23m"

Definition at line 464 of file orxDecl.h.

#define orxANSI_KZ_COLOR_ITALICS_ON   "\x1b[3m"

Definition at line 457 of file orxDecl.h.

#define orxANSI_KZ_COLOR_RESET   "\x1b[0m"

Definition at line 454 of file orxDecl.h.

#define orxANSI_KZ_COLOR_STRIKETHROUGH_OFF   "\x1b[29m"

Definition at line 468 of file orxDecl.h.

#define orxANSI_KZ_COLOR_STRIKETHROUGH_ON   "\x1b[9m"

Definition at line 461 of file orxDecl.h.

#define orxANSI_KZ_COLOR_UNDERLINE_OFF   "\x1b[24m"

Definition at line 465 of file orxDecl.h.

#define orxANSI_KZ_COLOR_UNDERLINE_ON   "\x1b[4m"

Definition at line 458 of file orxDecl.h.

#define orxARRAY_GET_ITEM_COUNT (   ARRAY)    (sizeof(ARRAY) / sizeof(ARRAY[0]))

Array macros

Definition at line 405 of file orxDecl.h.

#define orxDLLAPI   orxIMPORT orxDLLEXPORT /* Compiling orx library => API needs to be exported */

Definition at line 387 of file orxDecl.h.

#define orxFLAG_GET (   X,
 
)    ((X) & (M))

Gets flags

Parameters
[in]XFlag container
[in]MFiltering mask
Returns
Masked flags

Definition at line 429 of file orxDecl.h.

#define orxFLAG_SET (   X,
  A,
 
)
Value:
do \
{ \
(X) &= ~(R); \
(X) |= (A); \
} while(orxFALSE)
#define orxFALSE
Definition: orxType.h:185

Sets / unsets flags

Parameters
[in]XFlag container
[in]AFlags to add
[in]RFlags to remove

Definition at line 436 of file orxDecl.h.

#define orxFLAG_SWAP (   X,
 
)    ((X) ^= (S))

Swaps flags

Parameters
[in]XFlag container
[in]SFlags to swap

Definition at line 447 of file orxDecl.h.

#define orxFLAG_TEST (   X,
 
)    (((X) & (F)) != 0)

Tests flags

Parameters
[in]XFlag container
[in]FFlags to test
Returns
true if at least one flag is present

Definition at line 422 of file orxDecl.h.

#define orxFLAG_TEST_ALL (   X,
 
)    (((X) & (F)) == (F))

Flag macros Tests all flags

Parameters
[in]XFlag container
[in]FFlags to test
Returns
true if flags are all presents

Definition at line 415 of file orxDecl.h.

#define orxIMPORT

Definition at line 226 of file orxDecl.h.

#define orxSTRUCT_GET_FROM_FIELD (   TYPE,
  FIELD,
  POINTER 
)    ((TYPE *)((orxU8 *)(POINTER) - offsetof(TYPE, FIELD)))

Structure macros

Definition at line 401 of file orxDecl.h.


Generated for orx by doxygen 1.5.6