Package foundry.veil.api.client.render.ext

Enum Class VeilDebug

java.lang.Object

java.lang.Enum<VeilDebug>

foundry.veil.api.client.render.ext.VeilDebug

All Implemented Interfaces:

Serializable, Comparable<VeilDebug>, Constable

public enum VeilDebug
extends Enum<VeilDebug>

Provides access to debug functionality for all platforms.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLED
ENABLED

Field Summary

Fields

Modifier and Type	Field	Description
static final AtomicInteger	MESSAGE_ID

Method Summary

Modifier and Type	Method	Description
abstract void	debugMessageInsert(int type, int id, int severity, CharSequence message)	This function can be called by applications and third-party libraries to generate their own messages, such as ones containing timestamp information or signals about specific render system events.
static VeilDebug	get()
abstract void	objectLabel(int identifier, int name, @Nullable CharSequence label)	Labels a named object identified within a namespace.
abstract void	popDebugGroup()	Pops the active debug group.
abstract void	pushDebugGroup(CharSequence message)	Pushes a debug group described by the string message into the command stream.
static VeilDebug	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VeilDebug[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISABLED

public static final VeilDebug DISABLED

ENABLED

public static final VeilDebug ENABLED

Field Details

MESSAGE_ID

@Internal
public static final AtomicInteger MESSAGE_ID

Method Details

values

public static VeilDebug[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static VeilDebug valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

debugMessageInsert

public abstract void debugMessageInsert(int type,
 int id,
 int severity,
 CharSequence message)

This function can be called by applications and third-party libraries to generate their own messages, such as ones containing timestamp information or signals about specific render system events.

Parameters:

type - the type of the debug message insert

id - the user-supplied identifier of the message to insert

severity - the severity of the debug messages to insert

message - a character array containing the message to insert

objectLabel

public abstract void objectLabel(int identifier,
 int name,
 @Nullable
 @Nullable CharSequence label)

Labels a named object identified within a namespace.

Parameters:

identifier - the namespace from which the name of the object is allocated

name - the name of the object to label

label - a string containing the label to assign to the object

pushDebugGroup

public abstract void pushDebugGroup(CharSequence message)

Pushes a debug group described by the string message into the command stream. The value of id specifies the ID of messages generated. The parameter length contains the number of characters in message. If length is negative, it is implied that message contains a null terminated string. The message has the specified source and id, type DEBUG_TYPE_PUSH_GROUP, and severity DEBUG_SEVERITY_NOTIFICATION. The GL will put a new debug group on top of the debug group stack which inherits the control of the volume of debug output of the debug group previously residing on the top of the debug group stack. Because debug groups are strictly hierarchical, any additional control of the debug output volume will only apply within the active debug group and the debug groups pushed on top of the active debug group.

Parameters:

message - a string containing the message to be sent to the debug output stream

popDebugGroup

public abstract void popDebugGroup()

Pops the active debug group. When a debug group is popped, the GL will also generate a debug output message describing its cause based on the message string, the source source, and an ID id submitted to the associated PushDebugGroup command. DEBUG_TYPE_PUSH_GROUP and DEBUG_TYPE_POP_GROUP share a single namespace for message id. severity has the value DEBUG_SEVERITY_NOTIFICATION. The type has the value DEBUG_TYPE_POP_GROUP. Popping a debug group restores the debug output volume control of the parent debug group.

Attempting to pop the default debug group off the stack generates a STACK_UNDERFLOW error; pushing a debug group onto a stack containing MAX_DEBUG_GROUP_STACK_DEPTH minus one elements will generate a STACK_OVERFLOW error.

See Also:

• Reference Page

get

public static VeilDebug get()

Returns:

The best implementation of GL debug for this platform