public Class AMDDebugOutput

Tokens accepted by DebugMessageEnableAMD, GetDebugMessageLogAMD, and DEBUGPROCAMD callback function for category.

Tokens accepted by DebugMessageEnableAMD, GetDebugMessageLogAMD, and DEBUGPROCAMD callback function for category.

Tokens accepted by DebugMessageEnableAMD, GetDebugMessageLogAMD, and DEBUGPROCAMD callback function for category.

Tokens accepted by DebugMessageEnableAMD, GetDebugMessageLogAMD, and DEBUGPROCAMD callback function for category.

Tokens accepted by DebugMessageEnableAMD, GetDebugMessageLogAMD, and DEBUGPROCAMD callback function for category.

Tokens accepted by DebugMessageEnableAMD, GetDebugMessageLogAMD, and DEBUGPROCAMD callback function for category.

Tokens accepted by DebugMessageEnableAMD, GetDebugMessageLogAMD, and DEBUGPROCAMD callback function for category.

Tokens accepted by DebugMessageEnableAMD, GetDebugMessageLogAMD, and DEBUGPROCAMD callback function for category.

Tokens accepted by GetIntegerv.

Tokens accepted by DebugMessageEnableAMD, GetDebugMessageLogAMD, DebugMessageInsertAMD, and DEBUGPROCAMD callback function for severity.

Tokens accepted by DebugMessageEnableAMD, GetDebugMessageLogAMD, DebugMessageInsertAMD, and DEBUGPROCAMD callback function for severity.

Tokens accepted by DebugMessageEnableAMD, GetDebugMessageLogAMD, DebugMessageInsertAMD, and DEBUGPROCAMD callback function for severity.

Tokens accepted by GetIntegerv.

Tokens accepted by GetIntegerv.

Specifies a callback to receive debugging messages from the GL.

With callback storing the address of the callback function. This function's signature must follow the type definition of DEBUGPROCAMD, and its calling convention must be the same as the calling convention of GL functions. Anything else will result in undefined behavior. Only one debug callback can be specified for the current context, and further calls overwrite the previous callback. Specifying zero as the value of callback clears the current callback and disables message output through callbacks. Applications can specify user-specified data through the pointer userParam. The context will store this pointer and will include it as one of the parameters of each call to the callback function. The error INVALID_OPERATION will be generated if this function is called for contexts created without the debug flag.

If the application has specified a callback function in a debug context, the implementation will call that function whenever any unfiltered message is generated. The ID, category, and severity of the message are specified by the callback parameters id, category and severity, respectively. The string representation of the message is stored in message and its length (excluding the null-terminator) is stored in length. The parameter userParam is the user-specified value that was passed when calling DebugMessageCallbackAMD. The memory for message is allocated, owned and released by the implementation, and should only be considered valid for the duration of the callback function call. While it is allowed to concurrently use multiple debug contexts with the same debug callback function, note that it is the application's responsibility to ensure that any work that occurs inside the debug callback function is thread-safe. Furthermore, calling any GL or window layer function from within the callback function results in undefined behavior.

If no callback is set, then messages are instead stored in an internal message log up to some maximum number of strings as defined by the implementation-dependent constant MAX_DEBUG_LOGGED_MESSAGES_AMD. Each context stores its own message log and will only store messages generated by commands operating in that context. If the message log is full, then the oldest messages will be removed from the log to make room for newer ones. The application can query the number of messages currently in the log by obtaining the value of DEBUG_LOGGED_MESSAGES_AMD.

Parameters

callback:GLDebugMessageAMDCallbackI

a callback function that will be called when a debug message is generated

userParam:long

a user supplied pointer that will be passed on each invocation of callback

Allows disabling or enabling generation of subsets of messages. If enabled is TRUE, the referenced subset of messages is enabled. If FALSE, then those messages are disabled. This command can reference different subsets of messages by varying its parameter values in the following ways:

1. To reference all messages, let category, severity, and count all be zero. The value of ids is ignored in this case.
2. To reference all messages across all categories with a specific severity level, let category and count be zero and let severity identify the severity level. The value of ids is ignored in this case.
3. To reference all messages within a single category, let category identify the referenced category and let severity and count be zero. The value of ids is ignored in this case.
4. To reference all messages within a single category and at a specific severity level, let category identify the category and severity identify the severity level, and let count be zero. The value of ids is ignored in this case.
5. To reference specific messages by ID within a single category, let category identify the category, let severity be zero, let count be greater than zero and let ids identify the IDs of count messages within the identified category. Operations on message IDs that are not valid within the category are silently ignored.

In all of the above cases, if category is non-zero and specifies an invalid category, the error INVALID_ENUM is generated. Similarly if severity is non-zero and is an invalid severity level, the error INVALID_ENUM is generated. If count is less than zero, the error INVALID_VALUE is generated. If the parameters do not fall into one of the cases defined above, the error INVALID_VALUE is generated. The error INVALID_OPERATION is generated if this command is called in a non-debug context.

Although messages are grouped into categories and severities, and entire groups of messages can be turned off with a single call, there is no explicit per-category or per-severity enabled state. Instead the enabled state is stored individually for each message. There is no difference between disabling a category of messages with a single call, and enumerating all messages of that category and individually disabling each of them by their ID.

All messages of severity level DEBUG_SEVERITY_MEDIUM_AMD and DEBUG_SEVERITY_HIGH_AMD in all categories are initially enabled, and all messages at DEBUG_SEVERITY_LOW_AMD are initially disabled.

Parameters

category:int

the message category. One of:

DEBUG_CATEGORY_API_ERROR_AMD	DEBUG_CATEGORY_WINDOW_SYSTEM_AMD
DEBUG_CATEGORY_DEPRECATION_AMD	DEBUG_CATEGORY_UNDEFINED_BEHAVIOR_AMD
DEBUG_CATEGORY_PERFORMANCE_AMD	DEBUG_CATEGORY_SHADER_COMPILER_AMD
DEBUG_CATEGORY_APPLICATION_AMD	DEBUG_CATEGORY_OTHER_AMD

severity:int

the message severity. One of:

DEBUG_SEVERITY_HIGH_AMD

DEBUG_SEVERITY_MEDIUM_AMD

DEBUG_SEVERITY_LOW_AMD

ids:IntBuffer

an array of message ids

enabled:boolean

whether to enable or disable the referenced subset of messages

Allows disabling or enabling generation of subsets of messages. If enabled is TRUE, the referenced subset of messages is enabled. If FALSE, then those messages are disabled. This command can reference different subsets of messages by varying its parameter values in the following ways:

1. To reference all messages, let category, severity, and count all be zero. The value of ids is ignored in this case.
2. To reference all messages across all categories with a specific severity level, let category and count be zero and let severity identify the severity level. The value of ids is ignored in this case.
3. To reference all messages within a single category, let category identify the referenced category and let severity and count be zero. The value of ids is ignored in this case.
4. To reference all messages within a single category and at a specific severity level, let category identify the category and severity identify the severity level, and let count be zero. The value of ids is ignored in this case.
5. To reference specific messages by ID within a single category, let category identify the category, let severity be zero, let count be greater than zero and let ids identify the IDs of count messages within the identified category. Operations on message IDs that are not valid within the category are silently ignored.

In all of the above cases, if category is non-zero and specifies an invalid category, the error INVALID_ENUM is generated. Similarly if severity is non-zero and is an invalid severity level, the error INVALID_ENUM is generated. If count is less than zero, the error INVALID_VALUE is generated. If the parameters do not fall into one of the cases defined above, the error INVALID_VALUE is generated. The error INVALID_OPERATION is generated if this command is called in a non-debug context.

Although messages are grouped into categories and severities, and entire groups of messages can be turned off with a single call, there is no explicit per-category or per-severity enabled state. Instead the enabled state is stored individually for each message. There is no difference between disabling a category of messages with a single call, and enumerating all messages of that category and individually disabling each of them by their ID.

All messages of severity level DEBUG_SEVERITY_MEDIUM_AMD and DEBUG_SEVERITY_HIGH_AMD in all categories are initially enabled, and all messages at DEBUG_SEVERITY_LOW_AMD are initially disabled.

Parameters

category:int

the message category. One of:

DEBUG_CATEGORY_API_ERROR_AMD	DEBUG_CATEGORY_WINDOW_SYSTEM_AMD
DEBUG_CATEGORY_DEPRECATION_AMD	DEBUG_CATEGORY_UNDEFINED_BEHAVIOR_AMD
DEBUG_CATEGORY_PERFORMANCE_AMD	DEBUG_CATEGORY_SHADER_COMPILER_AMD
DEBUG_CATEGORY_APPLICATION_AMD	DEBUG_CATEGORY_OTHER_AMD

severity:int

the message severity. One of:

DEBUG_SEVERITY_HIGH_AMD

DEBUG_SEVERITY_MEDIUM_AMD

DEBUG_SEVERITY_LOW_AMD

enabled:boolean

whether to enable or disable the referenced subset of messages

Array version of: DebugMessageEnableAMD

Injects an application-supplied message into the debug message stream.

The value of id specifies the ID for the message and severity indicates its severity level as defined by the application. If severity is not a valid severity level, the error INVALID_ENUM will be generated. The value of category must be DEBUG_CATEGORY_APPLICATION_AMD, or the error INVALID_ENUM will be generated. The string buf contains the string representation of the message. The parameter length contains the size of the message's string representation, excluding the null-terminator. If length is zero, then its value is derived from the string-length of buf and buf must contain a null-terminated string. The error INVALID_VALUE will be generated if length is less than zero or its derived value is larger than or equal to MAX_DEBUG_MESSAGE_LENGTH_AMD. The error INVALID_OPERATION will be generated if this function is called in a non-debug context.

Parameters

category:int

the message category. Must be:

DEBUG_CATEGORY_APPLICATION_AMD

severity:int

the message severity. One of:

DEBUG_SEVERITY_HIGH_AMD

DEBUG_SEVERITY_MEDIUM_AMD

DEBUG_SEVERITY_LOW_AMD

id:int

the message id

buf:ByteBuffer

the message characters

Injects an application-supplied message into the debug message stream.

The value of id specifies the ID for the message and severity indicates its severity level as defined by the application. If severity is not a valid severity level, the error INVALID_ENUM will be generated. The value of category must be DEBUG_CATEGORY_APPLICATION_AMD, or the error INVALID_ENUM will be generated. The string buf contains the string representation of the message. The parameter length contains the size of the message's string representation, excluding the null-terminator. If length is zero, then its value is derived from the string-length of buf and buf must contain a null-terminated string. The error INVALID_VALUE will be generated if length is less than zero or its derived value is larger than or equal to MAX_DEBUG_MESSAGE_LENGTH_AMD. The error INVALID_OPERATION will be generated if this function is called in a non-debug context.

Parameters

category:int

the message category. Must be:

DEBUG_CATEGORY_APPLICATION_AMD

severity:int

the message severity. One of:

DEBUG_SEVERITY_HIGH_AMD

DEBUG_SEVERITY_MEDIUM_AMD

DEBUG_SEVERITY_LOW_AMD

id:int

the message id

buf:CharSequence

the message characters

Retrieves messages from the debug message log.

This function will fetch as many messages as possible from the message log up to count in order from oldest to newest, and will return the number of messages fetched. Those messages that were fetched will be removed from the log. The value of count must be greater than zero and less than MAX_DEBUG_LOGGED_MESSAGES_AMD or otherwise the error INVALID_VALUE will be generated. The value of count can be larger than the actual number of messages currently in the log. If messageLog is not a null pointer, then the string representations of all fetched messages will be stored in the buffer messageLog and will be separated by null-terminators. The maximum size of the buffer (including all null-terminators) is denoted by bufSize, and strings of messages within count that do not fit in the buffer will not be fetched. If bufSize is less than zero, the error INVALID_VALUE will be generated. If messageLog is a null pointer, then the value of bufSize is ignored. The categories, severity levels, IDs, and string representation lengths of all (up to count) removed messages will be stored in the arrays categories, severities, ids, and lengths, respectively. The counts stored in the array lengths include the null-terminator of each string. Any and all of the output arrays, including messageLog, are optional, and no data is returned for those arrays that are specified with a null pointer. To simply delete up to count messages from the message log and ignoring, the application can call the function with null pointers for all output arrays. The error INVALID_OPERATION will be generated by GetDebugMessageLogAMD if it is called in a non-debug context.

Parameters

count:int

the number of debug messages to retrieve from the log

categories:IntBuffer

an array of variables to receive the categories of the retrieved messages

severities:IntBuffer

an array of variables to receive the severities of the retrieved messages

ids:IntBuffer

an array of variables to receive the ids of the retrieved messages

lengths:IntBuffer

an array of variables to receive the lengths of the retrieved messages

messageLog:ByteBuffer

an array of characters that will receive the messages

Annotations

@NativeType:GLuint

Array version of: GetDebugMessageLogAMD

Annotations

@NativeType:GLuint

Unsafe version of: DebugMessageCallbackAMD

Unsafe version of: DebugMessageEnableAMD

Parameters

count:int

the number of values in the ids array

Unsafe version of: DebugMessageInsertAMD

Parameters

length:int

the number of character in the message

Unsafe version of: GetDebugMessageLogAMD

Parameters

bufsize:int

the maximum number of characters that can be written in the message array