Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkOpaqueCaptureDescriptorDataCreateInfoEXT

extends Struct<VkOpaqueCaptureDescriptorDataCreateInfoEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying opaque capture descriptor data.
Description

During replay, opaque descriptor capture data can be specified by adding a VkOpaqueCaptureDescriptorDataCreateInfoEXT structure to the relevant pNext chain of a VkBufferCreateInfo, VkImageCreateInfo, VkImageViewCreateInfo, VkSamplerCreateInfo, VkAccelerationStructureCreateInfoNV or VkAccelerationStructureCreateInfoKHR structure.

Valid Usage (Implicit)

Layout


struct VkOpaqueCaptureDescriptorDataCreateInfoEXT {
    VkStructureType sType;
    void const * pNext;
    void const * opaqueCaptureDescriptorData;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
OPAQUECAPTUREDESCRIPTORDATA

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkOpaqueCaptureDescriptorDataCreateInfoEXT(ByteBuffer container)

Creates a VkOpaqueCaptureDescriptorDataCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkOpaqueCaptureDescriptorDataCreateInfoEXT
calloc()

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance allocated with memCalloc.

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer instance allocated with memCalloc.

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VkOpaqueCaptureDescriptorDataCreateInfoEXT
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkOpaqueCaptureDescriptorDataCreateInfoEXT
create()

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance allocated with BufferUtils.

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT
create(long address)

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance for the specified memory address.

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer instance allocated with BufferUtils.

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer instance at the specified memory.

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT
malloc()

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance allocated with memAlloc.

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer instance allocated with memAlloc.

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance allocated on the specified MemoryStack.

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static long
public static void
nopaqueCaptureDescriptorData(long struct, long value)

Unsafe version of opaqueCaptureDescriptorData.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
public VkOpaqueCaptureDescriptorDataCreateInfoEXT
opaqueCaptureDescriptorData(long value)

Sets the specified value to the opaqueCaptureDescriptorData field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkOpaqueCaptureDescriptorDataCreateInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkOpaqueCaptureDescriptorDataCreateInfoEXT
set(int sType, long pNext, long opaqueCaptureDescriptorData)

Initializes this struct with the specified values.

public VkOpaqueCaptureDescriptorDataCreateInfoEXT

Returns:

this struct
set
(VkOpaqueCaptureDescriptorDataCreateInfoEXT
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkOpaqueCaptureDescriptorDataCreateInfoEXT
sType(int value)

Sets the specified value to the sType field.

public VkOpaqueCaptureDescriptorDataCreateInfoEXT
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

OPAQUECAPTUREDESCRIPTORDATAback to summary
public static final int OPAQUECAPTUREDESCRIPTORDATA

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkOpaqueCaptureDescriptorDataCreateInfoEXTback to summary
protected VkOpaqueCaptureDescriptorDataCreateInfoEXT(long address, ByteBuffer container)
VkOpaqueCaptureDescriptorDataCreateInfoEXTback to summary
public VkOpaqueCaptureDescriptorDataCreateInfoEXT(ByteBuffer container)

Creates a VkOpaqueCaptureDescriptorDataCreateInfoEXT 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 Detail

callocback to summary
public static VkOpaqueCaptureDescriptorDataCreateInfoEXT calloc()

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

callocback to summary
public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkOpaqueCaptureDescriptorDataCreateInfoEXT calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkOpaqueCaptureDescriptorDataCreateInfoEXT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkOpaqueCaptureDescriptorDataCreateInfoEXT create()

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkOpaqueCaptureDescriptorDataCreateInfoEXT create(long address)

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance for the specified memory address.

createback to summary
public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer create(int capacity)

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer create(long address, int capacity)

Create a VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkOpaqueCaptureDescriptorDataCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkOpaqueCaptureDescriptorDataCreateInfoEXT malloc()

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

mallocback to summary
public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkOpaqueCaptureDescriptorDataCreateInfoEXT malloc(MemoryStack stack)

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nopaqueCaptureDescriptorDataback to summary
public static long nopaqueCaptureDescriptorData(long struct)

Unsafe version of opaqueCaptureDescriptorData.

nopaqueCaptureDescriptorDataback to summary
public static void nopaqueCaptureDescriptorData(long struct, long value)

Unsafe version of opaqueCaptureDescriptorData.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

opaqueCaptureDescriptorDataback to summary
public long opaqueCaptureDescriptorData()

a pointer to a user-allocated buffer containing opaque capture data retrieved using GetBufferOpaqueCaptureDescriptorDataEXT, GetImageOpaqueCaptureDescriptorDataEXT, GetImageViewOpaqueCaptureDescriptorDataEXT, GetSamplerOpaqueCaptureDescriptorDataEXT, or GetAccelerationStructureOpaqueCaptureDescriptorDataEXT.

Annotations
@NativeType:void const *
opaqueCaptureDescriptorDataback to summary
public VkOpaqueCaptureDescriptorDataCreateInfoEXT opaqueCaptureDescriptorData(long value)

Sets the specified value to the opaqueCaptureDescriptorData field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkOpaqueCaptureDescriptorDataCreateInfoEXT pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkOpaqueCaptureDescriptorDataCreateInfoEXT set(int sType, long pNext, long opaqueCaptureDescriptorData)

Initializes this struct with the specified values.

setback to summary
public VkOpaqueCaptureDescriptorDataCreateInfoEXT set(VkOpaqueCaptureDescriptorDataCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkOpaqueCaptureDescriptorDataCreateInfoEXT

the source struct

Returns:VkOpaqueCaptureDescriptorDataCreateInfoEXT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkOpaqueCaptureDescriptorDataCreateInfoEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkOpaqueCaptureDescriptorDataCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_OPAQUE_CAPTURE_DESCRIPTOR_DATA_CREATE_INFO_EXT value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer

extends StructBuffer<VkOpaqueCaptureDescriptorDataCreateInfoEXT, VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkOpaqueCaptureDescriptorDataCreateInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkOpaqueCaptureDescriptorDataCreateInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkOpaqueCaptureDescriptorDataCreateInfoEXT
public long
public VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer
public long

Returns:

the value of the VkOpaqueCaptureDescriptorDataCreateInfoEXT#pNext field.
pNext
()

public VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkOpaqueCaptureDescriptorDataCreateInfoEXT#pNext field.

protected VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer
public int

Returns:

the value of the VkOpaqueCaptureDescriptorDataCreateInfoEXT#sType field.
sType
()

public VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkOpaqueCaptureDescriptorDataCreateInfoEXT#sType field.

public VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkOpaqueCaptureDescriptorDataCreateInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkOpaqueCaptureDescriptorDataCreateInfoEXT#SIZEOF, and its mark will be undefined.

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

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkOpaqueCaptureDescriptorDataCreateInfoEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
opaqueCaptureDescriptorDataback to summary
public long opaqueCaptureDescriptorData()
Returns:long

the value of the VkOpaqueCaptureDescriptorDataCreateInfoEXT#opaqueCaptureDescriptorData field.

Annotations
@NativeType:void const *
opaqueCaptureDescriptorDataback to summary
public VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer opaqueCaptureDescriptorData(long value)

Sets the specified value to the VkOpaqueCaptureDescriptorDataCreateInfoEXT#opaqueCaptureDescriptorData field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkOpaqueCaptureDescriptorDataCreateInfoEXT#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer pNext(long value)

Sets the specified value to the VkOpaqueCaptureDescriptorDataCreateInfoEXT#pNext field.

selfback to summary
protected VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkOpaqueCaptureDescriptorDataCreateInfoEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer sType(int value)

Sets the specified value to the VkOpaqueCaptureDescriptorDataCreateInfoEXT#sType field.

sType$Defaultback to summary
public VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_OPAQUE_CAPTURE_DESCRIPTOR_DATA_CREATE_INFO_EXT value to the VkOpaqueCaptureDescriptorDataCreateInfoEXT#sType field.