Primordial Machine's Visuals Library
Nothing to see here yet. Come back later, traveler.
Core_CanvasDpiChangedMessage
Signature
typedef struct Core_CanvasDpiChangedMessage Core_CanvasDpiChangedMessage;
Extends
Description
A message pertaining to a canvas dpi changed event.
Core_CanvasDpiChangedMessage_create
Signature
Core_Result Core_CanvasDpiChangedMessage_create(Core_CanvasDpiChangedMessage** RETURN, Core_Real32 horizontalDpi, Core_Real32 verticalDpi);
Description
Create a Core_CanvasDpiChangedMessage object.
Parameters
RETURN | Core_CanvasDpiChangedMessage** | A pointer to a Core_CanvasDpiChangedMessage* variable. |
horizontalDpi | Core_PixelFormat | The horizontal DPI. |
verticalDpi | Core_Natural32 | The vertical DPI. |
Success
*RETURN was assigned a pointer to the Core_CanvasDpiChangedMessage object.
Errors
Core_Error_ArgumentInvalid | RETURN is a null pointer. |
Core_Error_AllocationFailed | An allocation failed. |
Return
Core_Success on success. Core_Failure on failure.
Remarks
This function sets the by-thread error variable on failure.
Core_CanvasMessage
Signature
typedef struct Core_CanvasMessage Core_CanvasMessage;
Extends
Description
A message pertaining to a Canvas.
Core_CanvasMessageKind
Signature
typedef enum Core_CanvasMessageKind <implementation> Core_CanvasMessageKind;
Description
An enumeration of kinds of canvas messages.
Elements
Core_CanvasMessageKind_StateChanged | Kind of canvas state changed message. |
Core_CanvasMessageKind_SizeChanged | Kind of a canvas size changed message. |
Core_CanvasMessageKind_DpiChanged | Kind of a canvas DPI changed message. |
Core_CanvasSizeChangedMessage
Signature
typedef struct Core_CanvasSizeChangedMessage Core_CanvasSizeChangedMessage;
Extends
Description
A message pertaining to a canvas size changed event.
Core_CanvasSizeChangedMessage_create
Signature
Core_Result Core_CanvaSizeChangedMessage_create(Core_CanvaSizeChangedMessage** RETURN, Core_Real32 horizontalSize, Core_Real32 verticalSize);
Description
Create a Core_CanvasSizeChangedMessage object.
Parameters
RETURN | Core_CanvaSizeChangedMessage** | A pointer to a Core_CanvaSizeChangedMessage* variable. |
horizontalSize | Core_Real32 | The horizontal size, in pixels, of the canvas. |
verticalSize | Core_Real32 | The vertical size, in pixels, of the canvas. |
Success
*RETURN was assigned a pointer to the Core_CanvasSizeChangedMessage object.
Errors
Core_Error_ArgumentInvalid | RETURN is a null pointer. |
Core_Error_AllocationFailed | An allocation failed. |
Return
Core_Success on success. Core_Failure on failure.
Remarks
This function sets the by-thread error variable on failure.
Core_CanvasStateChangedMessage
Signature
typedef struct Core_CanvasStateChangedMessage Core_CanvasStateChangedMessage;
Extends
Description
A message pertaining to a canvas state changed event.
Core_CanvasStateChangedMessage_create
Signature
Core_Result Core_CanvasStateChangedMessage_create(Core_CanvasStateChangedMessage** RETURN, Core_Boolean active);
Description
Create a Core_CanvasStateChangedMessage object.
Parameters
RETURN | Core_CanvasStateChangedMessage** | A pointer to a Core_CanvasStateChangedMessage* variable. |
active | Core_Boolean | The activation state of the canvas. |
Success
*RETURN was assigned a pointer to the Core_CanvasStateChangedMessage object.
Errors
Core_Error_ArgumentInvalid | RETURN is a null pointer. |
Core_Error_AllocationFailed | An allocation failed. |
Return
Core_Success on success. Core_Failure on failure.
Remarks
This function sets the by-thread error variable on failure.
Core_CullMode
Signature
typedef enum Core_CullMode <implementation> Core_CullMode;
Description
This was replaced by https://michaelheilmann.com/repository/Arcadia.Visuals/#Arcadia_Visuals_CullMode.
Elements
Core_DepthCompareFunction
Signature
typedef enum Core_DepthCompareFunction <implementation> Core_DepthCompareFunction;
Description
This was replaced by https://michaelheilmann.com/repository/Arcadia.Visuals/#Arcadia_Visuals_DepthCompareFunction.
Elements
Core_PixelFormat
Signature
typedef enum Core_PixelFormat <implementation> Core_PixelFormat;
Description
This was replaced by https://michaelheilmann.com/repository/Arcadia.Visuals/#Arcadia_Visuals_PixelFormat.
Elements
Core_PixelFormat_getNumberOfBytes
Signature
Core_Result Core_PixelFormat_getNumberOfBytes(Core_Size* RETURN, Core_PixelFormat SELF);
Description
This was replaced by https://michaelheilmann.com/repository/Arcadia.Visuals/#Arcadia_Visuals_PixelFormat_getNumberOfBytes.
Parameters
RETURN | Core_Size | A pointer to a Core_Size variable. |
SELF | Core_PixelFormat | This Core_PixelFormat value. |
Success
*RETURN was assigned the number of Bytes of a pixel of the pixel format specified by Core_PixelFormat.
Errors
Core_Error_ArgumentInvalid | RETURN is a null pointer |
Return
Core_Success on success. Core_Failure on failure.
Remarks
This function sets the by-thread error variable on failure.
Core_PixelFormat_getNumberOfComponents
Signature
Core_Result Core_PixelFormat_getNumberOfComponents(Core_Size* RETURN, Core_PixelFormat SELF);
Description
This was replaced by https://michaelheilmann.com/repository/Arcadia.Visuals/#Arcadia_Visuals_PixelFormat_getNumberOfComponents.
Parameters
RETURN | Core_Size | A pointer to a Core_Size variable. |
SELF | Core_PixelFormat | This Core_PixelFormat value. |
Success
*RETURN was assigned the number of components of a pixel of the pixel format specified by Core_PixelFormat.
Errors
Core_Error_ArgumentInvalid | RETURN is a null pointer |
Return
Core_Success on success. Core_Failure on failure.
Remarks
This function sets the by-thread error variable on failure.
Core_TextureAddressMode
Signature
typedef enum Core_TextureAddressMode <implementation> Core_TextureAddressMode;
Description
This was replaced by https://michaelheilmann.com/repository/Arcadia.Visuals/#Arcadia_Visuals_TextureAddressMode.
Elements
Core_VertexFormat
Signature
typedef enum Core_VertexFormat <implementation> Core_VertexFormat;
Description
An enumeration of vertex formats.
Elements
Core_VertexFormat_PositionXyz | A vertex of the format xyz position. |
Core_VertexFormat_AmbientRgba | A vertex of the format rgba ambient. |
Core_VertexFormat_AmbientUv | A vertex of the format uv ambient. |
Core_VertexFormat_PositionXyzAmbientRgba | A vertex of the format xyz position first and rgba ambient last. |
Core_VertexFormat_PositionXyzAmbientUv | A vertex of the format xyz position first and uv ambient last. |
Core_VertexFormat_PositionXyzAmbientRgbaAmbientUv | A vertex of the format xyz positin first, rgba ambient second, and uv ambient last. |
Core_WindingMode
Signature
typedef enum Core_WindingMode <implementation> Core_WindingMode;
Description
This was replaced by https://michaelheilmann.com/repository/Arcadia.Visuals/#Arcadia_Visuals_WindingMode.