PySide6.QtOpenGL.QOpenGLDebugMessage

class QOpenGLDebugMessage

The QOpenGLDebugMessage class wraps an OpenGL debug message. More…

Synopsis

Methods

Static functions

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Debug messages are usually created by the OpenGL server and then read by OpenGL clients (either from the OpenGL internal debug log, or logged in real-time). A debug message has a textual representation, a vendor-specific numeric id, a source, a type and a severity.

It’s also possible for applications or third-party libraries and toolkits to create and insert messages in the debug log. In order to do so, you can use the createApplicationMessage() or the createThirdPartyMessage() static functions.

class Source

(inherits enum.Flag) The Source enum defines the source of the debug message.

Constant

Description

QOpenGLDebugMessage.InvalidSource

The source of the message is invalid; this is the source of a default-constructed QOpenGLDebugMessage object.

QOpenGLDebugMessage.APISource

The message was generated in response to OpenGL API calls.

QOpenGLDebugMessage.WindowSystemSource

The message was generated by the window system.

QOpenGLDebugMessage.ShaderCompilerSource

The message was generated by the shader compiler.

QOpenGLDebugMessage.ThirdPartySource

The message was generated by a third party, for instance an OpenGL framework a or debugging toolkit.

QOpenGLDebugMessage.ApplicationSource

The message was generated by the application itself.

QOpenGLDebugMessage.OtherSource

The message was generated by a source not included in this enumeration.

QOpenGLDebugMessage.AnySource

This value corresponds to a mask of all possible message sources.
class Type

(inherits enum.Flag) The Type enum defines the type of the debug message.

Constant

Description

QOpenGLDebugMessage.InvalidType

The type of the message is invalid; this is the type of a default-constructed QOpenGLDebugMessage object.

QOpenGLDebugMessage.ErrorType

The message represents an error.

QOpenGLDebugMessage.DeprecatedBehaviorType

The message represents an usage of deprecated behavior.

QOpenGLDebugMessage.UndefinedBehaviorType

The message represents an usage of undefined behavior.

QOpenGLDebugMessage.PortabilityType

The message represents an usage of vendor-specific behavior, that might pose portability concerns.

QOpenGLDebugMessage.PerformanceType

The message represents a performance issue.

QOpenGLDebugMessage.OtherType

The message represents a type not included in this enumeration.

QOpenGLDebugMessage.MarkerType

The message represents a marker in the debug log.

QOpenGLDebugMessage.GroupPushType

The message represents a debug group push operation.

QOpenGLDebugMessage.GroupPopType

The message represents a debug group pop operation.

QOpenGLDebugMessage.AnyType

This value corresponds to a mask of all possible message types.
class Severity

(inherits enum.Flag) The Severity enum defines the severity of the debug message.

Constant

Description

QOpenGLDebugMessage.InvalidSeverity

The severity of the message is invalid; this is the severity of a default-constructed QOpenGLDebugMessage object.

QOpenGLDebugMessage.HighSeverity

The message has a high severity.

QOpenGLDebugMessage.MediumSeverity

The message has a medium severity.

QOpenGLDebugMessage.LowSeverity

The message has a low severity.

QOpenGLDebugMessage.NotificationSeverity

The message is a notification.

QOpenGLDebugMessage.AnySeverity

This value corresponds to a mask of all possible message severities.
__init__()

Constructs a debug message with an empty message string, id set to 0, source set to InvalidSource , type set to InvalidType , and severity set to InvalidSeverity .

Note

This constructor should not be used to create a debug message; instead, use the createApplicationMessage() or the createThirdPartyMessage() static functions.

See also

createApplicationMessage() createThirdPartyMessage()

__init__(debugMessage)
Parameters:

debugMessage – QOpenGLDebugMessage

Constructs a debug message as a copy of debugMessage.

See also

operator=()

static createApplicationMessage(text[, id=0[, severity=QOpenGLDebugMessage.Severity.NotificationSeverity[, type=QOpenGLDebugMessage.Type.OtherType]]])
Parameters:

  • text – str

  • id – int

  • severity – Severity

  • type – Type

Return type:

QOpenGLDebugMessage

Constructs and returns a debug message with text as its text, id as id, severity as severity, and type as type. The message source will be set to ApplicationSource .

static createThirdPartyMessage(text[, id=0[, severity=QOpenGLDebugMessage.Severity.NotificationSeverity[, type=QOpenGLDebugMessage.Type.OtherType]]])
Parameters:

  • text – str

  • id – int

  • severity – Severity

  • type – Type

Return type:

QOpenGLDebugMessage

Constructs and returns a debug message with text as its text, id as id, severity as severity, and type as type. The message source will be set to ThirdPartySource .

id()
Return type:

int

Returns the id of the debug message. Ids are generally vendor-specific.

message()
Return type:

str

Returns the textual message contained by this debug message.

__ne__(debugMessage)
Parameters:

debugMessage – QOpenGLDebugMessage

Return type:

bool

Returns true if this message is different from debugMessage, or false otherwise.

See also

operator==()

__eq__(debugMessage)
Parameters:

debugMessage – QOpenGLDebugMessage

Return type:

bool

Returns true if this debug message is equal to debugMessage, or false otherwise. Two debugging messages are equal if they have the same textual message, the same id, the same source, the same type and the same severity.

See also

operator!=()

severity()
Return type:

Severity

Returns the severity of the debug message.

source()
Return type:

Source

Returns the source of the debug message.

swap(other)
Parameters:

other – QOpenGLDebugMessage

Swaps this message] with other. This operation is very fast and never fails.

type()
Return type:

Type

Returns the type of the debug message.