Package org.lwjgl.vulkan

Class VkOutOfBandQueueTypeInfoNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkOutOfBandQueueTypeInfoNV>

org.lwjgl.vulkan.VkOutOfBandQueueTypeInfoNV

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkOutOfBandQueueTypeInfoNV
extends org.lwjgl.system.Struct<VkOutOfBandQueueTypeInfoNV>
implements org.lwjgl.system.NativeResource

Structure used to describe the queue that is being marked as Out of Band.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_OUT_OF_BAND_QUEUE_TYPE_INFO_NV
• queueType must be a valid VkOutOfBandQueueTypeNV value

See Also

QueueNotifyOutOfBandNV

Layout

 struct VkOutOfBandQueueTypeInfoNV {
     VkStructureType sType();
     void const * pNext();
     VkOutOfBandQueueTypeNV queueType();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkOutOfBandQueueTypeInfoNV.Buffer	An array of VkOutOfBandQueueTypeInfoNV structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PNEXT	The struct member offsets.
static final int	QUEUETYPE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkOutOfBandQueueTypeInfoNV(ByteBuffer container)	Creates a VkOutOfBandQueueTypeInfoNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkOutOfBandQueueTypeInfoNV	calloc()	Returns a new VkOutOfBandQueueTypeInfoNV instance allocated with memCalloc.
static VkOutOfBandQueueTypeInfoNV.Buffer	calloc(int capacity)	Returns a new VkOutOfBandQueueTypeInfoNV.Buffer instance allocated with memCalloc.
static VkOutOfBandQueueTypeInfoNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkOutOfBandQueueTypeInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkOutOfBandQueueTypeInfoNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkOutOfBandQueueTypeInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkOutOfBandQueueTypeInfoNV	create()	Returns a new VkOutOfBandQueueTypeInfoNV instance allocated with BufferUtils.
static VkOutOfBandQueueTypeInfoNV.Buffer	create(int capacity)	Returns a new VkOutOfBandQueueTypeInfoNV.Buffer instance allocated with BufferUtils.
static VkOutOfBandQueueTypeInfoNV	create(long address)	Returns a new VkOutOfBandQueueTypeInfoNV instance for the specified memory address.
static VkOutOfBandQueueTypeInfoNV.Buffer	create(long address, int capacity)	Create a VkOutOfBandQueueTypeInfoNV.Buffer instance at the specified memory.
static @Nullable VkOutOfBandQueueTypeInfoNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkOutOfBandQueueTypeInfoNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkOutOfBandQueueTypeInfoNV	malloc()	Returns a new VkOutOfBandQueueTypeInfoNV instance allocated with memAlloc.
static VkOutOfBandQueueTypeInfoNV.Buffer	malloc(int capacity)	Returns a new VkOutOfBandQueueTypeInfoNV.Buffer instance allocated with memAlloc.
static VkOutOfBandQueueTypeInfoNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkOutOfBandQueueTypeInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkOutOfBandQueueTypeInfoNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkOutOfBandQueueTypeInfoNV instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nqueueType(long struct)	Unsafe version of queueType().
static void	nqueueType(long struct, int value)	Unsafe version of queueType.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkOutOfBandQueueTypeInfoNV	pNext(long value)	Sets the specified value to the pNext() field.
int	queueType()	describes the usage of the queue to be marked as out of band.
VkOutOfBandQueueTypeInfoNV	queueType(int value)	Sets the specified value to the queueType() field.
VkOutOfBandQueueTypeInfoNV	set(int sType, long pNext, int queueType)	Initializes this struct with the specified values.
VkOutOfBandQueueTypeInfoNV	set(VkOutOfBandQueueTypeInfoNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkOutOfBandQueueTypeInfoNV	sType(int value)	Sets the specified value to the sType() field.
VkOutOfBandQueueTypeInfoNV	sType$Default()	Sets the STRUCTURE_TYPE_OUT_OF_BAND_QUEUE_TYPE_INFO_NV value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

QUEUETYPE

public static final int QUEUETYPE

The struct member offsets.

Constructor Details

VkOutOfBandQueueTypeInfoNV

public VkOutOfBandQueueTypeInfoNV(ByteBuffer container)

Creates a VkOutOfBandQueueTypeInfoNV instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkOutOfBandQueueTypeInfoNV>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

queueType

public int queueType()

describes the usage of the queue to be marked as out of band.

sType

public VkOutOfBandQueueTypeInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkOutOfBandQueueTypeInfoNV sType$Default()

Sets the STRUCTURE_TYPE_OUT_OF_BAND_QUEUE_TYPE_INFO_NV value to the sType() field.

pNext

public VkOutOfBandQueueTypeInfoNV pNext(long value)

Sets the specified value to the pNext() field.

queueType

public VkOutOfBandQueueTypeInfoNV queueType(int value)

Sets the specified value to the queueType() field.

set

public VkOutOfBandQueueTypeInfoNV set(int sType,
 long pNext,
 int queueType)

Initializes this struct with the specified values.

set

public VkOutOfBandQueueTypeInfoNV set(VkOutOfBandQueueTypeInfoNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkOutOfBandQueueTypeInfoNV malloc()

Returns a new VkOutOfBandQueueTypeInfoNV instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkOutOfBandQueueTypeInfoNV calloc()

Returns a new VkOutOfBandQueueTypeInfoNV instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkOutOfBandQueueTypeInfoNV create()

Returns a new VkOutOfBandQueueTypeInfoNV instance allocated with BufferUtils.

create

public static VkOutOfBandQueueTypeInfoNV create(long address)

Returns a new VkOutOfBandQueueTypeInfoNV instance for the specified memory address.

createSafe

public static @Nullable VkOutOfBandQueueTypeInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkOutOfBandQueueTypeInfoNV.Buffer malloc(int capacity)

Returns a new VkOutOfBandQueueTypeInfoNV.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkOutOfBandQueueTypeInfoNV.Buffer calloc(int capacity)

Returns a new VkOutOfBandQueueTypeInfoNV.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkOutOfBandQueueTypeInfoNV.Buffer create(int capacity)

Returns a new VkOutOfBandQueueTypeInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkOutOfBandQueueTypeInfoNV.Buffer create(long address,
 int capacity)

Create a VkOutOfBandQueueTypeInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkOutOfBandQueueTypeInfoNV.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkOutOfBandQueueTypeInfoNV malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkOutOfBandQueueTypeInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkOutOfBandQueueTypeInfoNV calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkOutOfBandQueueTypeInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkOutOfBandQueueTypeInfoNV.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkOutOfBandQueueTypeInfoNV.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkOutOfBandQueueTypeInfoNV.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkOutOfBandQueueTypeInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nqueueType

public static int nqueueType(long struct)

Unsafe version of queueType().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nqueueType

public static void nqueueType(long struct,
 int value)

Unsafe version of queueType.