Status

Enumerations
enum	PuglStatus {   PUGL_SUCCESS , PUGL_FAILURE , PUGL_UNKNOWN_ERROR , PUGL_BAD_BACKEND ,   PUGL_BAD_CONFIGURATION , PUGL_BAD_PARAMETER , PUGL_BACKEND_FAILED , PUGL_REGISTRATION_FAILED ,   PUGL_REALIZE_FAILED , PUGL_SET_FORMAT_FAILED , PUGL_CREATE_CONTEXT_FAILED , PUGL_UNSUPPORTED ,   PUGL_NO_MEMORY }
	Return status code. More...

Functions
PUGL_CONST_API const char *	puglStrerror (PuglStatus status)
	Return a string describing a status code.

Detailed Description

Most functions return a status code which can be used to check for errors.

Enumeration Type Documentation

PuglStatus

enum PuglStatus

Return status code.

Enumerator
PUGL_SUCCESS	Success.
PUGL_FAILURE	Non-fatal failure.
PUGL_UNKNOWN_ERROR	Unknown system error.
PUGL_BAD_BACKEND	Invalid or missing backend.
PUGL_BAD_CONFIGURATION	Invalid view configuration.
PUGL_BAD_PARAMETER	Invalid parameter.
PUGL_BACKEND_FAILED	Backend initialization failed.
PUGL_REGISTRATION_FAILED	Class registration failed.
PUGL_REALIZE_FAILED	System view realization failed.
PUGL_SET_FORMAT_FAILED	Failed to set pixel format.
PUGL_CREATE_CONTEXT_FAILED	Failed to create drawing context.
PUGL_UNSUPPORTED	Unsupported operation.
PUGL_NO_MEMORY	Failed to allocate memory.

Function Documentation

puglStrerror()

PUGL_CONST_API const char * puglStrerror

(

PuglStatus

status

)

Return a string describing a status code.