Package org.lwjgl.vulkan

Class VkImageCaptureDescriptorDataInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageCaptureDescriptorDataInfoEXT>

org.lwjgl.vulkan.VkImageCaptureDescriptorDataInfoEXT

All Implemented Interfaces:

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

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

Structure specifying an image for descriptor capture.

Valid Usage

• image must have been created with IMAGE_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT set in VkImageCreateInfo::flags

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_CAPTURE_DESCRIPTOR_DATA_INFO_EXT
• pNext must be NULL
• image must be a valid VkImage handle

See Also

GetImageOpaqueCaptureDescriptorDataEXT

Layout

 struct VkImageCaptureDescriptorDataInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkImage image();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkImageCaptureDescriptorDataInfoEXT.Buffer	An array of VkImageCaptureDescriptorDataInfoEXT 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	IMAGE	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
VkImageCaptureDescriptorDataInfoEXT(ByteBuffer container)	Creates a VkImageCaptureDescriptorDataInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkImageCaptureDescriptorDataInfoEXT	calloc()	Returns a new VkImageCaptureDescriptorDataInfoEXT instance allocated with memCalloc.
static VkImageCaptureDescriptorDataInfoEXT.Buffer	calloc(int capacity)	Returns a new VkImageCaptureDescriptorDataInfoEXT.Buffer instance allocated with memCalloc.
static VkImageCaptureDescriptorDataInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageCaptureDescriptorDataInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageCaptureDescriptorDataInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageCaptureDescriptorDataInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageCaptureDescriptorDataInfoEXT	create()	Returns a new VkImageCaptureDescriptorDataInfoEXT instance allocated with BufferUtils.
static VkImageCaptureDescriptorDataInfoEXT.Buffer	create(int capacity)	Returns a new VkImageCaptureDescriptorDataInfoEXT.Buffer instance allocated with BufferUtils.
static VkImageCaptureDescriptorDataInfoEXT	create(long address)	Returns a new VkImageCaptureDescriptorDataInfoEXT instance for the specified memory address.
static VkImageCaptureDescriptorDataInfoEXT.Buffer	create(long address, int capacity)	Create a VkImageCaptureDescriptorDataInfoEXT.Buffer instance at the specified memory.
static @Nullable VkImageCaptureDescriptorDataInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkImageCaptureDescriptorDataInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	image()	the VkImage handle of the image to get opaque capture data for.
VkImageCaptureDescriptorDataInfoEXT	image(long value)	Sets the specified value to the image() field.
static VkImageCaptureDescriptorDataInfoEXT	malloc()	Returns a new VkImageCaptureDescriptorDataInfoEXT instance allocated with memAlloc.
static VkImageCaptureDescriptorDataInfoEXT.Buffer	malloc(int capacity)	Returns a new VkImageCaptureDescriptorDataInfoEXT.Buffer instance allocated with memAlloc.
static VkImageCaptureDescriptorDataInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageCaptureDescriptorDataInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkImageCaptureDescriptorDataInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageCaptureDescriptorDataInfoEXT instance allocated on the specified MemoryStack.
static long	nimage(long struct)	Unsafe version of image().
static void	nimage(long struct, long value)	Unsafe version of image.
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	pNext()	NULL or a pointer to a structure extending this structure.
VkImageCaptureDescriptorDataInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkImageCaptureDescriptorDataInfoEXT	set(int sType, long pNext, long image)	Initializes this struct with the specified values.
VkImageCaptureDescriptorDataInfoEXT	set(VkImageCaptureDescriptorDataInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkImageCaptureDescriptorDataInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkImageCaptureDescriptorDataInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_IMAGE_CAPTURE_DESCRIPTOR_DATA_INFO_EXT 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.

IMAGE

public static final int IMAGE

The struct member offsets.

Constructor Details

VkImageCaptureDescriptorDataInfoEXT

public VkImageCaptureDescriptorDataInfoEXT(ByteBuffer container)

Creates a VkImageCaptureDescriptorDataInfoEXT 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<VkImageCaptureDescriptorDataInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

image

public long image()

the VkImage handle of the image to get opaque capture data for.

sType

public VkImageCaptureDescriptorDataInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImageCaptureDescriptorDataInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_CAPTURE_DESCRIPTOR_DATA_INFO_EXT value to the sType() field.

pNext

public VkImageCaptureDescriptorDataInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

image

public VkImageCaptureDescriptorDataInfoEXT image(long value)

Sets the specified value to the image() field.

set

public VkImageCaptureDescriptorDataInfoEXT set(int sType,
 long pNext,
 long image)

Initializes this struct with the specified values.

set

public VkImageCaptureDescriptorDataInfoEXT set(VkImageCaptureDescriptorDataInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageCaptureDescriptorDataInfoEXT malloc()

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

calloc

public static VkImageCaptureDescriptorDataInfoEXT calloc()

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

create

public static VkImageCaptureDescriptorDataInfoEXT create()

Returns a new VkImageCaptureDescriptorDataInfoEXT instance allocated with BufferUtils.

create

public static VkImageCaptureDescriptorDataInfoEXT create(long address)

Returns a new VkImageCaptureDescriptorDataInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkImageCaptureDescriptorDataInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageCaptureDescriptorDataInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageCaptureDescriptorDataInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageCaptureDescriptorDataInfoEXT.Buffer create(int capacity)

Returns a new VkImageCaptureDescriptorDataInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageCaptureDescriptorDataInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkImageCaptureDescriptorDataInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nimage

public static long nimage(long struct)

Unsafe version of image().

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.

nimage

public static void nimage(long struct,
 long value)

Unsafe version of image.