orx 1.16
Portable Game Engine
Loading...
Searching...
No Matches
OrxDecl

Macros

#define __orx32__
#define __orxLITTLE_ENDIAN__
#define __orxX86__
#define orxALIGN(VALUE, BLOCK_SIZE)
#define orxALIGN16(VALUE)
#define orxALIGN32(VALUE)
#define orxALIGN64(VALUE)
#define orxALIGN8(VALUE)
#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)
#define orxDLLAPI   orxIMPORT orxDLLEXPORT /* Compiling orx library => API needs to be exported */
#define orxFLAG_GET(X, M)
#define orxFLAG_SET(X, A, R)
#define orxFLAG_SWAP(X, S)
#define orxFLAG_TEST(X, F)
#define orxFLAG_TEST_ALL(X, F)
#define orxIMPORT
#define orxSTRUCT_GET_FROM_FIELD(TYPE, FIELD, POINTER)

Detailed Description

Base declarations

Macro Definition Documentation

◆ __orx32__

#define __orx32__

Definition at line 172 of file orxDecl.h.

◆ __orxLITTLE_ENDIAN__

#define __orxLITTLE_ENDIAN__

Definition at line 130 of file orxDecl.h.

◆ __orxX86__

#define __orxX86__

Definition at line 99 of file orxDecl.h.

◆ orxALIGN

#define orxALIGN ( VALUE,
BLOCK_SIZE )
Value:
(((orxUPTR)(VALUE) + ((orxUPTR)(BLOCK_SIZE) - 1)) & (~((orxUPTR)(BLOCK_SIZE) - 1)))

Memory alignment macros

Definition at line 387 of file orxDecl.h.

◆ orxALIGN16

#define orxALIGN16 ( VALUE)
Value:
orxALIGN(VALUE, 16)
orxALIGN
#define orxALIGN(VALUE, BLOCK_SIZE)
Definition orxDecl.h:387

Definition at line 390 of file orxDecl.h.

◆ orxALIGN32

#define orxALIGN32 ( VALUE)
Value:
orxALIGN(VALUE, 32)

Definition at line 391 of file orxDecl.h.

◆ orxALIGN64

#define orxALIGN64 ( VALUE)
Value:
orxALIGN(VALUE, 64)

Definition at line 392 of file orxDecl.h.

◆ orxALIGN8

#define orxALIGN8 ( VALUE)
Value:
orxALIGN(VALUE, 8)

Definition at line 389 of file orxDecl.h.

◆ orxANSI_KC_MARKER

#define orxANSI_KC_MARKER   '\x1b'

ANSI macros

Definition at line 447 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_BG_BLACK

#define orxANSI_KZ_COLOR_BG_BLACK   "\x1b[40m"

Definition at line 475 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_BG_BLUE

#define orxANSI_KZ_COLOR_BG_BLUE   "\x1b[44m"

Definition at line 479 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_BG_CYAN

#define orxANSI_KZ_COLOR_BG_CYAN   "\x1b[46m"

Definition at line 481 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_BG_DEFAULT

#define orxANSI_KZ_COLOR_BG_DEFAULT   "\x1b[49m"

Definition at line 483 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_BG_GREEN

#define orxANSI_KZ_COLOR_BG_GREEN   "\x1b[42m"

Definition at line 477 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_BG_MAGENTA

#define orxANSI_KZ_COLOR_BG_MAGENTA   "\x1b[45m"

Definition at line 480 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_BG_RED

#define orxANSI_KZ_COLOR_BG_RED   "\x1b[41m"

Definition at line 476 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_BG_WHITE

#define orxANSI_KZ_COLOR_BG_WHITE   "\x1b[47m"

Definition at line 482 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_BG_YELLOW

#define orxANSI_KZ_COLOR_BG_YELLOW   "\x1b[43m"

Definition at line 478 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_BLINK_OFF

#define orxANSI_KZ_COLOR_BLINK_OFF   "\x1b[25m"

Definition at line 461 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_BLINK_ON

#define orxANSI_KZ_COLOR_BLINK_ON   "\x1b[5m"

Definition at line 454 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_BOLD_OFF

#define orxANSI_KZ_COLOR_BOLD_OFF   "\x1b[22m"

Definition at line 458 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_BOLD_ON

#define orxANSI_KZ_COLOR_BOLD_ON   "\x1b[1m"

Definition at line 451 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_FG_BLACK

#define orxANSI_KZ_COLOR_FG_BLACK   "\x1b[30m"

Definition at line 465 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_FG_BLUE

#define orxANSI_KZ_COLOR_FG_BLUE   "\x1b[34m"

Definition at line 469 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_FG_CYAN

#define orxANSI_KZ_COLOR_FG_CYAN   "\x1b[36m"

Definition at line 471 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_FG_DEFAULT

#define orxANSI_KZ_COLOR_FG_DEFAULT   "\x1b[39m"

Definition at line 473 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_FG_GREEN

#define orxANSI_KZ_COLOR_FG_GREEN   "\x1b[32m"

Definition at line 467 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_FG_MAGENTA

#define orxANSI_KZ_COLOR_FG_MAGENTA   "\x1b[35m"

Definition at line 470 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_FG_RED

#define orxANSI_KZ_COLOR_FG_RED   "\x1b[31m"

Definition at line 466 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_FG_WHITE

#define orxANSI_KZ_COLOR_FG_WHITE   "\x1b[37m"

Definition at line 472 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_FG_YELLOW

#define orxANSI_KZ_COLOR_FG_YELLOW   "\x1b[33m"

Definition at line 468 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_INVERSE_OFF

#define orxANSI_KZ_COLOR_INVERSE_OFF   "\x1b[27m"

Definition at line 462 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_INVERSE_ON

#define orxANSI_KZ_COLOR_INVERSE_ON   "\x1b[7m"

Definition at line 455 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_ITALICS_OFF

#define orxANSI_KZ_COLOR_ITALICS_OFF   "\x1b[23m"

Definition at line 459 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_ITALICS_ON

#define orxANSI_KZ_COLOR_ITALICS_ON   "\x1b[3m"

Definition at line 452 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_RESET

#define orxANSI_KZ_COLOR_RESET   "\x1b[0m"

Definition at line 449 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_STRIKETHROUGH_OFF

#define orxANSI_KZ_COLOR_STRIKETHROUGH_OFF   "\x1b[29m"

Definition at line 463 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_STRIKETHROUGH_ON

#define orxANSI_KZ_COLOR_STRIKETHROUGH_ON   "\x1b[9m"

Definition at line 456 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_UNDERLINE_OFF

#define orxANSI_KZ_COLOR_UNDERLINE_OFF   "\x1b[24m"

Definition at line 460 of file orxDecl.h.

◆ orxANSI_KZ_COLOR_UNDERLINE_ON

#define orxANSI_KZ_COLOR_UNDERLINE_ON   "\x1b[4m"

Definition at line 453 of file orxDecl.h.

◆ orxARRAY_GET_ITEM_COUNT

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

Array macros

Definition at line 400 of file orxDecl.h.

◆ orxDLLAPI

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

Definition at line 381 of file orxDecl.h.

◆ orxFLAG_GET

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

Gets flags

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

Definition at line 424 of file orxDecl.h.

◆ orxFLAG_SET

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

Sets / unsets flags

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

Definition at line 431 of file orxDecl.h.

◆ orxFLAG_SWAP

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

Swaps flags

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

Definition at line 442 of file orxDecl.h.

◆ orxFLAG_TEST

#define orxFLAG_TEST ( X,
F )
Value:
(((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 417 of file orxDecl.h.

◆ orxFLAG_TEST_ALL

#define orxFLAG_TEST_ALL ( X,
F )
Value:
(((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 410 of file orxDecl.h.

◆ orxIMPORT

#define orxIMPORT

Definition at line 227 of file orxDecl.h.

◆ orxSTRUCT_GET_FROM_FIELD

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

Structure macros

Definition at line 396 of file orxDecl.h.

Generated for orx by doxygen 1.8.11