Package org.lwjgl.vulkan

Class VkImageSubresource2

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageSubresource2>

org.lwjgl.vulkan.VkImageSubresource2

All Implemented Interfaces:

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

Direct Known Subclasses:

VkImageSubresource2EXT, VkImageSubresource2KHR

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

Structure specifying an image subresource.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_SUBRESOURCE_2
• pNext must be NULL
• imageSubresource must be a valid VkImageSubresource structure

See Also

VkDeviceImageSubresourceInfo, VkImageSubresource, GetImageSubresourceLayout2, GetImageSubresourceLayout2EXT, GetImageSubresourceLayout2KHR

Layout

 struct VkImageSubresource2 {
     VkStructureType sType();
     void * pNext();
     VkImageSubresource imageSubresource();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

IMAGESUBRESOURCE

public static final int IMAGESUBRESOURCE

The struct member offsets.

Constructor Details

VkImageSubresource2

public VkImageSubresource2(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

imageSubresource

public VkImageSubresource imageSubresource()

a VkImageSubresource structure.

sType

public VkImageSubresource2 sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImageSubresource2 sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_SUBRESOURCE_2 value to the sType() field.

pNext

public VkImageSubresource2 pNext(long value)

Sets the specified value to the pNext() field.

imageSubresource

public VkImageSubresource2 imageSubresource(VkImageSubresource value)

Copies the specified VkImageSubresource to the imageSubresource() field.

imageSubresource

public VkImageSubresource2 imageSubresource(Consumer<VkImageSubresource> consumer)

Passes the imageSubresource() field to the specified Consumer.

set

public VkImageSubresource2 set(int sType,
 long pNext,
 VkImageSubresource imageSubresource)

Initializes this struct with the specified values.

set

public VkImageSubresource2 set(VkImageSubresource2 src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageSubresource2 malloc()

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

calloc

public static VkImageSubresource2 calloc()

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

create

public static VkImageSubresource2 create()

Returns a new VkImageSubresource2 instance allocated with BufferUtils.

create

public static VkImageSubresource2 create(long address)

Returns a new VkImageSubresource2 instance for the specified memory address.

createSafe

public static @Nullable VkImageSubresource2 createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageSubresource2.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageSubresource2.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageSubresource2.Buffer create(int capacity)

Returns a new VkImageSubresource2.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageSubresource2.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkImageSubresource2 instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nimageSubresource

public static VkImageSubresource nimageSubresource(long struct)

Unsafe version of imageSubresource().

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.

nimageSubresource

public static void nimageSubresource(long struct,
 VkImageSubresource value)

Unsafe version of imageSubresource.