Home

Michael Heilmann's Arcadia Visuals

This is the documentation for Michael Heilmann's Arcadia Visuals. Arcadia Visuals provides

Documentation

[MIL] Arcadia.Visuals.ApplicationEvent

class Arcadia.Visuals.ApplicationEvent extends Arcadia.Visuals.Event { ... } A application event.

[MIL] Arcadia.Visuals.ApplicationEvent.construct

void
Arcadia.Visuals.ApplicationEvent.construct
  (
    Arcadia.Natural64 timeStamp
  ) Construct this application event.

Parameters

Arcadia.Natural64 timeStamp
The timestamp of this event.

[MIL] Arcadia.Visuals.ApplicationQuitRequestedEvent

class Arcadia.Visuals.ApplicationQuitRequestedEvent extends Arcadia.Visuals.ApplicationEvent { ... } An event raised if the application received a request to quit.

[MIL] Arcadia.Visuals.ApplicationQuitRequestedEvent.construct

void
Arcadia.Visuals.ApplicationQuitRequestedEvent.construct
  (
    Arcadia.Natural64 timeStamp
  ) Construct this application quit requested event.

Parameters

Arcadia.Natural64 timeStamp
The timestamp of this event.

[MIL] Arcadia.Visuals.CanvasActivationStateChangedEvent

class Arcadia.Visuals.CanvasActivationStateChangedEvent extends Arcadia.Visuals.CanvasEvent { ... } A canvas activation state changed event.

[MIL] Arcadia.Visuals.CanvasActivationStateChangedEvent.construct

void
Arcadia.Visuals.CanvasActivationStateChangedEvent.construct
  (
    Arcadia.Natural64 timeStamp,
    Arcadia.Boolean active
  ) Construct this canvas activation state changed event.

Parameters

Arcadia.Natural64 timeStamp
The timestamp of this event.
Arcadia.Boolean active
Arcadia.Boolean.True if the canvas activation state is active. Arcadia.Boolean.False if the canvas activation state is inactive.

[MIL] Arcadia.Visuals.CanvasEvent

class Arcadia.Visuals.CanvasEvent extends Arcadia.Visuals.Event { ... } The ancestor type of all canvas events.

[MIL] Arcadia.Visuals.CanvasEvent.construct

void
Arcadia.Visuals.CanvasEvent.construct
  (
    Arcadia.Natural64 timeStamp
  ) Construct this canvas event.

Parameters

Arcadia.Natural64 timeStamp
The timestamp of this event.

[MIL] Arcadia.Visuals.CanvasDpiChangedEvent

class Arcadia.Visuals.CanvasDpiChangedEvent extends Arcadia.Visuals.CanvasEvent { ... } A canvas DPI changed event.

[MIL] Arcadia.Visuals.CanvasDpiChangedEvent.construct

void
Arcadia.Visuals.CanvasDpiChangedEvent.construct
  (
    Arcadia.Natural64 timeStamp,
    Arcadia.Natural32 horizontalDpi,
    Arcadia.Natural32 verticalDpi
  ) Construct this canvas DPI changed event.

Parameters

Arcadia.Natural64 timeStamp
The timestamp of this event.
Arcadia.Integer32 horizontalDpi
The horizontal DPI of the canvas.
Arcadia.Integer32 verticalDpi
The vertical DPI of the canvas.

[MIL] Arcadia.Visuals.CanvasSizeChangedEvent

class Arcadia.Visuals.CanvasSizeChangedEvent extends Arcadia.Visuals.CanvasEvent { ... } A canvas size changed event.

[MIL] Arcadia.Visuals.CanvasSizeChangedEvent.construct

void
Arcadia.Visuals.CanvasSizeChangedEvent.construct
  (
    Arcadia.Natural64 timeStamp,
    Arcadia.Integer32 horizontalSize,
    Arcadia.Integer32 verticalSize
  ) Construct this canvas size changed event.

Parameters

Arcadia.Natural64 timeStamp
The timestamp of this event.
Arcadia.Integer32 horizontalSize
The horizontal size, in pixels, of the canvas.
Arcadia.Integer32 verticalSize
The vertical size, in pixels, of the canvas.

Arcadia_Visuals_CullMode

typedef enum Arcadia_Visuals_CullMode Arcadia_Visuals_CullMode; An enumeration of cull modes. A cull mode identifies a technique for deciding wether a fragment is removed based on its facing towards the viewer.

Elements

Arcadia_Visuals_CullMode_None
Neither front-facing nor back-facing fragments are culled.
Arcadia_Visuals_CullMode_Front
Front-facing fragments are culled.
Arcadia_Visuals_CullMode_Back
Back-facing fragments are culled.
Arcadia_Visuals_CullMode_FrontAndBack
Both front-facing and back-facing fragments are culled. This is an alias of Arcadia_Visuals_CullMode_BackAndFront.
Arcadia_Visuals_CullMode_BackAndFront
Both back-facing and front-facing fragments are culled. This is an alias of Arcadia_Visuals_CullMode_FrontAndBack.

Arcadia_Visuals_DepthCompareFunction

typedef enum Arcadia_Visuals_DepthCompareFunction Arcadia_Visuals_DepthCompareFunction; An enumeration of depth compare functions. A depth compare function identifies a technique that compares depth value of an incoming fragment to its corresponding depth value in the depth buffer.

Elements

Arcadia_Visuals_DepthComparefunction_Always
The incoming fragment always passes.
Arcadia_Visuals_DepthCompareFunction_Never
The incoming fragment never passes.
Arcadia_Visuals_DepthCompareFunction_EqualTo
The incoming fragment passes if its depth value is equal to its corresponding depth value in the depth buffer.
Arcadia_Visuals_DepthCompareFunction_NotEqualTo
The incoming fragment passes if its depth value is not equal to its corresponding depth value in the depth buffer.
Arcadia_Visuals_DepthCompareFunction_LessThan
The incoming fragment passes if its depth value is less than its corresponding depth value in the depth buffer.
Arcadia_Visuals_DepthCompareFunction_LessThanOrEqualTo
The incoming fragment passes if its depth value is less than or equal to its corresponding depth value in the depth buffer.
Arcadia_Visuals_DepthCompareFunction_GreaterThan
The incoming fragment passes if its depth value is greater than its corresponding depth value in the depth buffer.
Arcadia_Visuals_DepthCompareFunction_GreaterThanOrEqualTo
The incoming fragment passes if its depth value is greater than or equal to its corresponding depth value in the depth buffer.

Arcadia.Visuals.Event

class Arcadia.Visuals.Event extends Arcadia.Object { ... }

The ancestor type of all events.

[MIL] Arcadia.Visuals.Event.construct

void
Arcadia.Visuals.Event.construct
  (
    Arcadia.Natural64 timestamp
  ) Construct this event.

Parameters

Arcadia.Natural64 timestamp
The timestamp of this event.

Arcadia_Visuals_FillMode

typedef enum Arcadia_Visuals_FillMode Arcadia_Visuals_FillMode; An enumeration of fill modes. The fill mode determines how the vertices, edges, and/or surfaces of a polygon are rendered.

Elements

Arcadia_Visuals_FillMode_Point
Polygon vertices that are marked as the start of a boundary edge are drawn as points.
Arcadia_Visuals_FillMode_Line
Boundary edges of the polygon are drawn as line segments.
Arcadia_Visuals_FillMode_Solid
The interior of the polygon is filled.

Arcadia_Visuals_KeyboardKey

typedef enum Arcadia_Visuals_KeyboardKey Arcadia_Visuals_KeyboardKey; An enumeration of keyboard keys.

The numeric values of the digit keys form a consecutive range with Arcadia_Visuals_KeyboardKey_D0 being the lowest of value and Arcadia_Visuals_KeyboardKey_D9 being the highest of value. Furthermore, the digit key constant of a lower number has a lower value than the digit key constant of a higher number.


The numeric values of the letter keys form a consecutive range with Arcadia_Visuals_KeyboardKey_A being the lowest value and Arcadia_Visuals_KeyboardKey_Z being the highest of value. Furthermore, the letter key constant of a letter lower in the alphabet has a lower value than the letter key constant of a letter higher in the alphabet.


The numeric values of the numpad digit keys form a consecutive range with Arcadia_Visuals_KeyboardKey_NumPad0 being the lowest of value and Arcadia_Visuals_KeyboardKey_NumPad9 being the highest of value. Furthermore, the numpad digit key constant of a lower number has a lower value than the numpad digit key constant of a higher number.

Elements

Arcadia_Visuals_KeyboardKey_A
The A key.
Arcadia_Visuals_KeyboardKey_Accept
The IME Accept key.
Arcadia_Visuals_KeyboardKey_Add
The Add key.
Arcadia_Visuals_KeyboardKey_Applications
The Applications key (on Microsoft Natural Keyboard).
Arcadia_Visuals_KeyboardKey_B
The B key.
Arcadia_Visuals_KeyboardKey_Backspace
The Backspace key.
Arcadia_Visuals_KeyboardKey_BrowserBack
The Browser Back key.
Arcadia_Visuals_KeyboardKey_BrowserFavorites
The Browser Favorites key.
Arcadia_Visuals_KeyboardKey_BrowserForward
The Browser Forward key.
Arcadia_Visuals_KeyboardKey_BrowserHome
The Browser Home key.
Arcadia_Visuals_KeyboardKey_BrowserRefresh
The Browser Refresh key.
Arcadia_Visuals_KeyboardKey_BrowserSearch
The Browser Search key.
Arcadia_Visuals_KeyboardKey_BrowserStop
The Browser Stop key.
Arcadia_Visuals_KeyboardKey_C
The C key.
Arcadia_Visuals_KeyboardKey_Capital
The Capital key.
Arcadia_Visuals_KeyboardKey_CapsLock
The Caps Lock key.
Arcadia_Visuals_KeyboardKey_Clear
The Clear key.
Arcadia_Visuals_KeyboardKey_Comma
The Comma key.
Arcadia_Visuals_KeyboardKey_Convert
The IME Convert key.
Arcadia_Visuals_KeyboardKey_D
The D key.
Arcadia_Visuals_KeyboardKey_D0
The 0 key.
Arcadia_Visuals_KeyboardKey_D1
The 1 key.
Arcadia_Visuals_KeyboardKey_D2
The 2 key.
Arcadia_Visuals_KeyboardKey_D3
The 3 key.
Arcadia_Visuals_KeyboardKey_D4
The 4 key.
Arcadia_Visuals_KeyboardKey_D5
The 5 key.
Arcadia_Visuals_KeyboardKey_D6
The 6 key.
Arcadia_Visuals_KeyboardKey_D7
The 7 key.
Arcadia_Visuals_KeyboardKey_D8
The 8 key.
Arcadia_Visuals_KeyboardKey_D9
The 9 key.
Arcadia_Visuals_KeyboardKey_Decimal
The Decimal Separator key (on number pad).
Arcadia_Visuals_KeyboardKey_Delete
The Delete key.
Arcadia_Visuals_KeyboardKey_Down
The Down Arrow key. This is an alias of Arcadia_Visuals_KeyboardKey_DownArrow.
Arcadia_Visuals_KeyboardKey_DownArray
The Down Arrow key. This is an alias of Arcadia_Visuals_KeyboardKey_Down.
Arcadia_Visuals_KeyboardKey_E
The E key.
Arcadia_Visuals_KeyboardKey_End
The End key.
Arcadia_Visuals_KeyboardKey_Escape
The Escape key.
Arcadia_Visuals_KeyboardKey_F
The F key.
Arcadia_Visuals_KeyboardKey_F1
The F1 key.
Arcadia_Visuals_KeyboardKey_F10
The F10 key.
Arcadia_Visuals_KeyboardKey_F11
The F11 key.
Arcadia_Visuals_KeyboardKey_F12
The F12 key.
Arcadia_Visuals_KeyboardKey_F13
The F13 key.
Arcadia_Visuals_KeyboardKey_F14
The F14 key.
Arcadia_Visuals_KeyboardKey_F15
The F15 key.
Arcadia_Visuals_KeyboardKey_F16
The F16 key.
Arcadia_Visuals_KeyboardKey_F17
The F17 key.
Arcadia_Visuals_KeyboardKey_F18
The F18 key.
Arcadia_Visuals_KeyboardKey_F19
The F19 key.
Arcadia_Visuals_KeyboardKey_F2
The F2 key.
Arcadia_Visuals_KeyboardKey_F20
The F20 key.
Arcadia_Visuals_KeyboardKey_F21
The F21 key.
Arcadia_Visuals_KeyboardKey_F22
The F22 key.
Arcadia_Visuals_KeyboardKey_F23
The F23 key.
Arcadia_Visuals_KeyboardKey_F24
The F24 key.
Arcadia_Visuals_KeyboardKey_F3
The F3 key.
Arcadia_Visuals_KeyboardKey_F4
The F4 key.
Arcadia_Visuals_KeyboardKey_F5
The F5 key.
Arcadia_Visuals_KeyboardKey_F6
The F6 key.
Arcadia_Visuals_KeyboardKey_F7
The F7 key.
Arcadia_Visuals_KeyboardKey_F8
The F8 key.
Arcadia_Visuals_KeyboardKey_F9
The F9 key.
Arcadia_Visuals_KeyboardKey_FinalMode
The IME Final Mode key.
Arcadia_Visuals_KeyboardKey_G
The G key.
Arcadia_Visuals_KeyboardKey_H
The H key.
Arcadia_Visuals_KeyboardKey_HangulMode
The IME Hangul Mode key.
Arcadia_Visuals_KeyboardKey_HanjaMode
The IME Hanja Mode key.
Arcadia_Visuals_KeyboardKey_Home
The Home key.
Arcadia_Visuals_KeyboardKey_I
The I key.
Arcadia_Visuals_KeyboardKey_Insert
The Insert key.
Arcadia_Visuals_KeyboardKey_J
The J key.
Arcadia_Visuals_KeyboardKey_JunjaMode
The IME Junja Mode key.
Arcadia_Visuals_KeyboardKey_K
The K key.
Arcadia_Visuals_KeyboardKey_KanaMode
The IME Kana Mode key.
Arcadia_Visuals_KeyboardKey_KanjiMode
The IME Kanji Mode key.
Arcadia_Visuals_KeyboardKey_L
The L key.
Arcadia_Visuals_KeyboardKey_Left
The Left Arrow key. This is an alias of Arcadia_Visuals_KeyboardKey_LeftArrow.
Arcadia_Visuals_KeyboardKey_LeftArrow
The Left Arrow key. This is an alias of Arcadia_Visuals_KeyboardKey_Left.
Arcadia_Visuals_KeyboardKey_LeftControl
The Left Control key.
Arcadia_Visuals_KeyboardKey_LeftMenu
The Left Menu key.
Arcadia_Visuals_KeyboardKey_LeftShift
The Left Shift key.
Arcadia_Visuals_KeyboardKey_LeftWindows
The Left Windows key (on Microsoft Natural Keyboard).
Arcadia_Visuals_KeyboardKey_M
The M key.
Arcadia_Visuals_KeyboardKey_Minus
The Minus key.
Arcadia_Visuals_KeyboardKey_ModeChange
The IME Mode Change key.
Arcadia_Visuals_KeyboardKey_Multiply
The Multiply Change key.
Arcadia_Visuals_KeyboardKey_N
The N key.
Arcadia_Visuals_KeyboardKey_NonConvert
The IME Non Convert key.
Arcadia_Visuals_KeyboardKey_NumberSign
The Number Sign key.
Arcadia_Visuals_KeyboardKey_NumPad0
The 0 key on the numeric keypad.
Arcadia_Visuals_KeyboardKey_NumPad1
The 1 key on the numeric keypad.
Arcadia_Visuals_KeyboardKey_NumPad2
The 2 key on the numeric keypad.
Arcadia_Visuals_KeyboardKey_NumPad3
The 3 key on the numeric keypad.
Arcadia_Visuals_KeyboardKey_NumPad4
The 4 key on the numeric keypad.
Arcadia_Visuals_KeyboardKey_NumPad5
The 5 key on the numeric keypad.
Arcadia_Visuals_KeyboardKey_NumPad6
The 6 key on the numeric keypad.
Arcadia_Visuals_KeyboardKey_NumPad7
The 7 key on the numeric keypad.
Arcadia_Visuals_KeyboardKey_NumPad8
The 8 key on the numeric keypad.
Arcadia_Visuals_KeyboardKey_NumPad9
The 9 key on the numeric keypad.
Arcadia_Visuals_KeyboardKey_O
The O key.
Arcadia_Visuals_KeyboardKey_P
The P key.
Arcadia_Visuals_KeyboardKey_PageDown
The Page Down key.
Arcadia_Visuals_KeyboardKey_PageUp
The Page Up key.
Arcadia_Visuals_KeyboardKey_Pause
The Pause key.
Arcadia_Visuals_KeyboardKey_Period
The Period key.
Arcadia_Visuals_KeyboardKey_Print
The Print key.
Arcadia_Visuals_KeyboardKey_Plus
The Plus key.
Arcadia_Visuals_KeyboardKey_Q
The Q key.
Arcadia_Visuals_KeyboardKey_R
The R key.
Arcadia_Visuals_KeyboardKey_Return
The Return key.
Arcadia_Visuals_KeyboardKey_Right
The Right Arrow key. This is an alias of Arcadia_Visuals_KeyboardKey_RightArrow.
Arcadia_Visuals_KeyboardKey_RightArrow
The Right Arrow key. This is an alias of Arcadia_Visuals_KeyboardKey_Right.
Arcadia_Visuals_KeyboardKey_RightControl
The Right Control key.
Arcadia_Visuals_KeyboardKey_RightMenu
The Right Menu key.
Arcadia_Visuals_KeyboardKey_RightShift
The Right Shift key.
Arcadia_Visuals_KeyboardKey_RightWindows
The Right Windows key (on Microsoft Natural Keyboard).
Arcadia_Visuals_KeyboardKey_S
The S key.
Arcadia_Visuals_KeyboardKey_ScrollLock
The Scroll Lock key.
Arcadia_Visuals_KeyboardKey_Sleep
The Sleep key.
Arcadia_Visuals_KeyboardKey_Space
The Space key.
Arcadia_Visuals_KeyboardKey_Subtract
The Subtract key.
Arcadia_Visuals_KeyboardKey_T
The T key.
Arcadia_Visuals_KeyboardKey_Tabulator
The Tabulator key.
Arcadia_Visuals_KeyboardKey_U
The U key.
Arcadia_Visuals_KeyboardKey_Up
The Up Arrow key. This is an alias of Arcadia_Visuals_KeyboardKey_UpArrow.
Arcadia_Visuals_KeyboardKey_UpArrow
The Up Arrow key. This is an alias of Arcadia_Visuals_KeyboardKey_Up.
Arcadia_Visuals_KeyboardKey_V
The V key.
Arcadia_Visuals_KeyboardKey_W
The W key.
Arcadia_Visuals_KeyboardKey_X
The X key.
Arcadia_Visuals_KeyboardKey_Y
The Y key.
Arcadia_Visuals_KeyboardKey_Z
The Z key.

Arcadia_Visuals_KeyboardKeyAction

typedef enum Arcadia_Visuals_KeyboardKeyAction Arcadia_Visuals_KeyboardKeyAction; An enumeration of actions of a keyboard key.

Elements

Arcadia_Visuals_KeyboardKeyAction_Pressed
The keyboard key was pressed.
Arcadia_Visuals_KeyboardKeyAction_Released
The keyboard key was released.

[MIL] Arcadia.Visuals.KeyboardKeyEvent

class Arcadia.Visuals.KeyboardKeyEvent extends Arcadia.Visuals.Event { ... } A keyboard key event.

[MIL] Arcadia.Visuals.KeyboardKeyEvent.construct

void
Arcadia.Visuals.KeyboardKeyEvent.construct
  (
    Arcadia.Natural64 timestamp,
    Arcadia.Visuals.KeyboardKeyAction action,
    Arcadia.Visuals.KeyboardKey key
  ) Construct this keyboard key event.

Parameters

Arcadia.Natural64 timestamp
The timestamp of this event.
Arcadia.Visuals.KeyboardKeyAction action
The keyboard key action.
Arcadia.Visuals.KeyboardKey key
The keyboard key.

[MIL] Arcadia.Visuals.KeyboardKeyEvent.getAction

void
Arcadia.Visuals.KeyboardKeyAction
Arcadia.Visuals.KeyboardKeyEvent.getAction
  (
  ) Get the keyboard key action of this keyboard key event.

Return value

The keyboard key action.

[MIL] Arcadia.Visuals.KeyboardKeyEvent.getKey

void
Arcadia.Visuals.KeyboardKey
Arcadia.Visuals.KeyboardKeyEvent.getKey
  (
  ) Get the keyboard key of this keyboard key event.

Return value

The keyboard key.

Arcadia_Visuals_MouseButtonAction

typedef enum Arcadia_Visuals_MouseButtonAction Arcadia_Visuals_MouseButtonAction; An enumeration of actions of a mouse button.

Elements

Arcadia_Visuals_MouseButtonAction_Pressed
The mouse button was pressed.
Arcadia_Visuals_MouseButtonAction_Released
The mouse button was released.

[MIL] Arcadia.Visuals.MouseButtonEvent

class Arcadia.Visuals.MouseButtonEvent extends Arcadia.Visuals.Event { ... } A mouse button event.

[MIL] Arcadia.Visuals.MouseButtonEvent.construct

void
Arcadia.Visuals.MouseButtonEvent.construct
  (
    Arcadia.Natural64 timestamp,
    Arcadia.Visuals.MouseButtonAction action,
    Arcadia.Natural64Value button,
    Arcadia.Integer64Value x,
    Arcadia.Integer64Value y
  ) Construct this canvas activation state changed event.

Parameters

Arcadia.Natural64 timestamp
The timestamp of this event.
Arcadia.Visuals.MouseButtonAction action
The mouse button action.
Arcadia.Natural64 button
The zero-based index of the mouse button.
Arcadia.Integer32 x
The position along the x-axis of the mouse pointer..
Arcadia.Integer32 y
The position along the y-axis of the mouse pointer..

Arcadia_Visuals_MousePointerAction

typedef enum Arcadia_Visuals_MousePointerAction Arcadia_Visuals_MousePointerAction; An enumeration of actions of a mouse pointer.

Elements

Arcadia_Visuals_MousePointerAction_Entered
The mouse pointer entered an entity.
Arcadia_Visuals_MousePointerAction_Exited
The mouse pointer exited an entity.
Arcadia_Visuals_MousePointerAction_Moved
The mouse pointer moved.

[MIL] Arcadia.Visuals.MouseButtonEvent

class Arcadia.Visuals.MouseButtonEvent extends Arcadia.Visuals.Event { ... } A mouse button event.

[MIL] Arcadia.Visuals.MouseButtonEvent.construct

void
Arcadia.Visuals.MouseButtonEvent.construct
  (
    Arcadia.Natural64 timestamp,
    Arcadia.Visuals.MousePointerAction action,
    Arcadia.Integer32 x,
    Arcadia.Integer32 y
  ) Construct this mouse button event.

Parameters

Arcadia.Natural64 timestamp
The timestamp of this event.
Arcadia.Visuals.MousePointerAction action
The mouse pointer action.
Arcadia.Integer32 x
The position along the x-axis of the mouse pointer.
Arcadia.Integer32 y
The position along the y-axis of the mouse pointer.

Arcadia_Visuals_PixelFormat

typedef enum Arcadia_Visuals_PixelFormat Arcadia_Visuals_PixelFormat; An enumeration of pixel formats.

Elements

Arcadia_Visuals_PixelFormat_An8Ln8
Two Arcadia_Natural8Value values layout out consecutively in memory. The first value denotes the intensity of the alpha component. The second value denotes the intensity of the luminance component. A component value of 0 indicates least intensity. A component value of 255 indicates greatest intensity.
Arcadia_Visuals_PixelFormat_An8Bn8Gn8Rn8
Four Arcadia_Natural8Value values layed out consecutively in memory. The first value denotes the intensity of the alpha component. The second value denotes the intensity of the blue component, the third value denotes the intensity of the green component, and the fourth value denotes the intensity of the red component. A component value of 0 indicates least intensity. A component value of 255 indicates greatest intensity.
Arcadia_Visuals_PixelFormat_An8Rn8Gn8Bn8
Four Arcadia_Natural8Value values layed out consecutively in memory. The first value denotes the intensity of the alpha component. The second value denotes the intensity of the red component, the third value denotes the intensity of the green component, and the fourth value denotes the intensity of the blue component. A component value of 0 indicates least intensity. A component value of 255 indicates greatest intensity.
Arcadia_Visuals_PixelFormat_Bn8Gn8Rn8
Three Arcadia_Natural8Value values layed out consecutively in memory. The first value denotes the intensity of the blue component, the second value denotes the intensity of the green component, and the third value denotes the intensity of the red component. A component value of 0 indicates least intensity. A component value of 255 indicates greatest intensity.
Arcadia_Visuals_PixelFormat_Bn8Gn8Rn8An8
Four Arcadia_Natural8Value values layed out consecutively in memory. The first value denotes the intensity of the blue component, the second value denotes the intensity of the green component, and the third value denotes the intensity of the red component. The fourth value denotes the intensity of the alpha component. A component value of 0 indicates least intensity. A component value of 255 indicates greatest intensity.
Arcadia_Visuals_PixelFormat_Ln8
One Arcadia_Natural8Value value. The value denotes the intensity of the luminance component. A component value of 0 indicates least intensity. A component value of 255 indicates greatest intensity.
Arcadia_Visuals_PixelFormat_Ln8An8
Two Arcadia_Natural8Value values layout out consecutively in memory. The first value denotes the intensity of the luminance component. The second value denotes the intensity of the alpha component. A component value of 0 indicates least intensity. A component value of 255 indicates greatest intensity.
Arcadia_Visuals_PixelFormat_Rn8Gn8Bn8
Three Arcadia_Natural8Value values layed out consecutively in memory. The first value denotes the intensity of the red component, the second value denotes the intensity of the green component, and the third value denotes the intensity of the blue component. A component value of 0 indicates least intensity. A component value of 255 indicates greatest intensity.
Arcadia_Visuals_PixelFormat_Rn8Gn8Bn8An8
Four Arcadia_Natural8Value values layed out consecutively in memory. The first value denotes the intensity of the red component, the second value denotes the intensity of the green component, and the third value denotes the intensity of the blue component. The fourth value denotes the intensity of the alpha component. A component value of 0 indicates least intensity. A component value of 255 indicates greatest intensity.

Arcadia_Visuals_PixelFormat_getNumberOfComponents

Arcadia_SizeValue
Arcadia_Visuals_PixelFormat_getNumberOfComponents
  (
    Arcadia_Thread* thread,
    Arcadia_Visuals_PixelFormat self
  ) Get the number of components of a pixel of a pixel format.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_Visuals_PixelFormat self
This pixel format.

Return value

The number of components of a pixel of this pixel format.

Arcadia_Visuals_PixelFormat_getNumberOfBytes

Arcadia_SizeValue Arcadia_Visuals_PixelFormat_getNumberOfBytes
  (
    Arcadia_Thread* thread,
    Arcadia_Visuals_PixelFormat self
  ) Get the number of Bytes of a pixel of a pixel format.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_Visuals_PixelFormat self
This pixel format.

Return value

The number of Bytes of a pixel of this pixel format.

Arcadia_Visuals_TextureAddressMode

typedef enum Arcadia_Visuals_TextureAddressMode Arcadia_Visuals_TextureAddressMode; An enumeration of texture address modes. A texture address mode identifies a technique for resolving uv coordinates that are outside of the boundaries of a texture.

Elements

Arcadia_Visuals_TextureAddressMode_ClampToEdge
uv coordinates outside of the range of [0,1] are assigned the color of the uv coordinate at 0 or 1, respectively. This usually corresponds to GL_TEXTURE_WRAP_S/GL_TEXTURE_WRAP_T with GL_CLAMP_TO_EDGE in OpenGL and D3D12_TEXTURE_ADDRESS_MODE_CLAMP in Direct3D 12.
Arcadia_Visuals_TextureAddressMode_ClampToBorder
uv coordinates outside of the range of [0,1] are assigned the border color of the texture. This usually corresponds to GL_TEXTURE_WRAP_S/GL_TEXTURE_WRAP_T with GL_CLAMP_TO_BORDER in OpenGL and D3D12_TEXTURE_ADDRESS_MODE_BORDER in Direct3D 12.
Arcadia_Visuals_TextureAddressMode_Repeat
Tile the texture at every uv coordinate integer junction. For example, for the u coordinates between 0 and 3, the texture is repeated three times. This usually corresponds to GL_TEXTURE_WRAP_S/GL_TEXTURE_WRAP_T with GL_REPEAT in OpenGL and D3D12_TEXTURE_ADDRESS_MODE_WRAP in Direct3D 12.
Arcadia_Visuals_TextureAddressMode_MirroredRepeat
Tile and flip the texture at every uv coordinate integer junction. For example, for the u coordinates between 0 and 3, the texture is repeated three times. For the u coordinates between 0 and 1 and 2 and 3 the texture is address normally. For the u coordinates between 1 and 2, the texture flipped. This usually corresponds to GL_TEXTURE_WRAP_S/GL_TEXTURE_WRAP_T with GL_MIRRORED_REPEAT in OpenGL, D3D12_TEXTURE_ADDRESS_MODE_MIRROR in Direct3D 12.

Arcadia_Visuals_TextureFilter

typedef enum Arcadia_Visuals_TextureFilter Arcadia_Visuals_TextureFilter; An enumeration of texture filters. A texture filter identifies a technique to compute the pixel value closed to the specified uv coordinates.

Elements

Arcadia_Visuals_TextureFilter_Nearest
Filter using the texture element that is nearest (in Manhatten distance) to the specified uv coordinates.
Arcadia_Visuals_TextureFilter_Linear
Returns the weighted average of the four texture elements that are closest to the specified uv coordinates. These can include items wrapped or repeated from other parts of the texture, depending on the texture address mode.

Arcadia_Visuals_VertexElementSemantics

typedef enum Arcadia_Visuals_VertexElementSemantics Arcadia_Visuals_VertexElementSemantics; An enumeration of pixel formats.

Elements

Arcadia_Visuals_VertexElementSemantics_PositionXyz
The vertex element denotes a position coordinate. If the vertex syntax is Arcadia_Visuals_VertexElementSyntax_Real32Real32, then this the position coordinate is in XY space (model, local, or global). If the vertex syntax is Arcadia_Visuals_VertexElementSyntax_Real32Real32Real32, then this the position coordinate is in XYZ space (model, local, or global).
Arcadia_Visuals_VertexElementSemantics_AmbientRgba
The vertex element denotes an ambient color coordinate.
  • If the vertex syntax is Arcadia_Visuals_VertexElementSyntax_Real32Real32Real32, then the color is in [0,1] RGB space. The first Arcadia_Real32Value indicates the intensity of the red component, the second Arcadia_Real32Value indicates the intensity of the green component, the third Arcadia_Real32Value indicates the intensity of the blue component. 0 indicates minimum intensity, 1 indicates maximum intensity.
  • If the vertex syntax is Arcadia_Visuals_VertexElementSyntax_Real32Real32Real32Real32, then the color is in [0,1] RGBA space. The first Arcadia_Real32Value indicates the intensity of the red component, the second Arcadia_Real32Value indicates the intensity of the green component, the third Arcadia_Real32Value indicates the intensity of the blue component. 0 indicates minimum intensity, 1 indicates maximum intensity. The fourth Arcadia_Real32Value indicates the intensity of the alpha component. 0 indicates fully transparent, 1 indicates fully opaque.
Arcadia_Visuals_VertexElementSemantics_AmbientUv
The vertex element denotes a texture coordinates for an ambient texture. If the vertex syntax is Arcadia_Visuals_VertexElementSyntax_Real32Real32, then this the texture coordinate is in UV space.

Arcadia_Visuals_VertexElementSyntax

typedef enum Arcadia_Visuals_VertexElementSyntaxt Arcadia_Visuals_VertexElementSyntax; An enumeration of pixel formats.

Elements

Arcadia_Visuals_VertexElementSyntax_Real32Real32
The vertex element consists of two consecutive Arcadia_Real32Value values.
Arcadia_Visuals_VertexElementSyntax_Real32Real32Real32
The vertex element consists of three consecutive Arcadia_Real32Value values.
Arcadia_Visuals_VertexElementSyntax_Real32Real32Real32Real32
The vertex element consists of four consecutive Arcadia_Real32Value values.

Arcadia_Visuals_WindingMode

typedef enum Arcadia_Visuals_WindingMode Arcadia_Visuals_WindingMode; An enumeration of winding modes.

Elements

Arcadia_Visuals_WindingMode_Clockwise
Clockwise winding mode.
Arcadia_Visuals_WindingMode_CounterClockwise
Counter clockwise winding mode.