Package org.lwjgl.vulkan

Class VkOpaqueCaptureDescriptorDataCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkOpaqueCaptureDescriptorDataCreateInfoEXT>

org.lwjgl.vulkan.VkOpaqueCaptureDescriptorDataCreateInfoEXT

All Implemented Interfaces:

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

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

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)

• sType must be STRUCTURE_TYPE_OPAQUE_CAPTURE_DESCRIPTOR_DATA_CREATE_INFO_EXT
• opaqueCaptureDescriptorData must be a pointer value

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer	An array of VkOpaqueCaptureDescriptorDataCreateInfoEXT 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	OPAQUECAPTUREDESCRIPTORDATA	The struct member offsets.
static final int	PNEXT	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
VkOpaqueCaptureDescriptorDataCreateInfoEXT(ByteBuffer container)	Creates a VkOpaqueCaptureDescriptorDataCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkOpaqueCaptureDescriptorDataCreateInfoEXT	calloc()	Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance allocated with memCalloc.
static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer instance allocated with memCalloc.
static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkOpaqueCaptureDescriptorDataCreateInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkOpaqueCaptureDescriptorDataCreateInfoEXT	create()	Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance allocated with BufferUtils.
static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer	create(int capacity)	Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer instance allocated with BufferUtils.
static VkOpaqueCaptureDescriptorDataCreateInfoEXT	create(long address)	Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance for the specified memory address.
static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer	create(long address, int capacity)	Create a VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer instance at the specified memory.
static @Nullable VkOpaqueCaptureDescriptorDataCreateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkOpaqueCaptureDescriptorDataCreateInfoEXT	malloc()	Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance allocated with memAlloc.
static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer instance allocated with memAlloc.
static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkOpaqueCaptureDescriptorDataCreateInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance allocated on the specified MemoryStack.
static long	nopaqueCaptureDescriptorData(long struct)	Unsafe version of opaqueCaptureDescriptorData().
static void	nopaqueCaptureDescriptorData(long struct, long value)	Unsafe version of opaqueCaptureDescriptorData.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	opaqueCaptureDescriptorData()	a pointer to an application-allocated buffer containing opaque capture data retrieved using GetBufferOpaqueCaptureDescriptorDataEXT, GetImageOpaqueCaptureDescriptorDataEXT, GetImageViewOpaqueCaptureDescriptorDataEXT, GetSamplerOpaqueCaptureDescriptorDataEXT, or GetAccelerationStructureOpaqueCaptureDescriptorDataEXT.
VkOpaqueCaptureDescriptorDataCreateInfoEXT	opaqueCaptureDescriptorData(long value)	Sets the specified value to the opaqueCaptureDescriptorData() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkOpaqueCaptureDescriptorDataCreateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkOpaqueCaptureDescriptorDataCreateInfoEXT	set(int sType, long pNext, long opaqueCaptureDescriptorData)	Initializes this struct with the specified values.
VkOpaqueCaptureDescriptorDataCreateInfoEXT	set(VkOpaqueCaptureDescriptorDataCreateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkOpaqueCaptureDescriptorDataCreateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkOpaqueCaptureDescriptorDataCreateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_OPAQUE_CAPTURE_DESCRIPTOR_DATA_CREATE_INFO_EXT value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

OPAQUECAPTUREDESCRIPTORDATA

public static final int OPAQUECAPTUREDESCRIPTORDATA

The struct member offsets.

Constructor Details

VkOpaqueCaptureDescriptorDataCreateInfoEXT

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 Details

sizeof

public int sizeof()

Specified by:

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

opaqueCaptureDescriptorData

public long opaqueCaptureDescriptorData()

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

sType

public VkOpaqueCaptureDescriptorDataCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkOpaqueCaptureDescriptorDataCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_OPAQUE_CAPTURE_DESCRIPTOR_DATA_CREATE_INFO_EXT value to the sType() field.

pNext

public VkOpaqueCaptureDescriptorDataCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

opaqueCaptureDescriptorData

public VkOpaqueCaptureDescriptorDataCreateInfoEXT opaqueCaptureDescriptorData(long value)

Sets the specified value to the opaqueCaptureDescriptorData() field.

set

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

Initializes this struct with the specified values.

set

public VkOpaqueCaptureDescriptorDataCreateInfoEXT set(VkOpaqueCaptureDescriptorDataCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT malloc()

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

calloc

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT calloc()

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

create

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT create()

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance allocated with BufferUtils.

create

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT create(long address)

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkOpaqueCaptureDescriptorDataCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer create(int capacity)

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkOpaqueCaptureDescriptorDataCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkOpaqueCaptureDescriptorDataCreateInfoEXT.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().

nopaqueCaptureDescriptorData

public static long nopaqueCaptureDescriptorData(long struct)

Unsafe version of opaqueCaptureDescriptorData().

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.

nopaqueCaptureDescriptorData

public static void nopaqueCaptureDescriptorData(long struct,
 long value)

Unsafe version of opaqueCaptureDescriptorData.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate