Package org.lwjgl.vulkan

Class VkSubresourceLayout2

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSubresourceLayout2>

org.lwjgl.vulkan.VkSubresourceLayout2

All Implemented Interfaces:

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

Direct Known Subclasses:

VkSubresourceLayout2EXT, VkSubresourceLayout2KHR

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

Structure specifying subresource layout.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SUBRESOURCE_LAYOUT_2
• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkImageCompressionPropertiesEXT or VkSubresourceHostMemcpySize
• The sType value of each struct in the pNext chain must be unique

See Also

VkSubresourceLayout, GetDeviceImageSubresourceLayout, GetDeviceImageSubresourceLayoutKHR, GetImageSubresourceLayout2, GetImageSubresourceLayout2EXT, GetImageSubresourceLayout2KHR

Layout

 struct VkSubresourceLayout2 {
     VkStructureType sType();
     void * pNext();
     VkSubresourceLayout subresourceLayout();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSubresourceLayout2.Buffer	An array of VkSubresourceLayout2 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	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	SUBRESOURCELAYOUT	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
VkSubresourceLayout2(ByteBuffer container)	Creates a VkSubresourceLayout2 instance at the current position of the specified ByteBuffer container.

Method Summary

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

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.

SUBRESOURCELAYOUT

public static final int SUBRESOURCELAYOUT

The struct member offsets.

Constructor Details

VkSubresourceLayout2

public VkSubresourceLayout2(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

subresourceLayout

public VkSubresourceLayout subresourceLayout()

a VkSubresourceLayout structure.

sType

public VkSubresourceLayout2 sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkSubresourceLayout2 sType$Default()

Sets the STRUCTURE_TYPE_SUBRESOURCE_LAYOUT_2 value to the sType() field.

pNext

public VkSubresourceLayout2 pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkSubresourceLayout2 pNext(VkImageCompressionPropertiesEXT value)

Prepends the specified VkImageCompressionPropertiesEXT value to the pNext chain.

pNext

public VkSubresourceLayout2 pNext(VkSubresourceHostMemcpySize value)

Prepends the specified VkSubresourceHostMemcpySize value to the pNext chain.

pNext

public VkSubresourceLayout2 pNext(VkSubresourceHostMemcpySizeEXT value)

Prepends the specified VkSubresourceHostMemcpySizeEXT value to the pNext chain.

set

public VkSubresourceLayout2 set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkSubresourceLayout2 set(VkSubresourceLayout2 src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSubresourceLayout2 malloc()

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

calloc

public static VkSubresourceLayout2 calloc()

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

create

public static VkSubresourceLayout2 create()

Returns a new VkSubresourceLayout2 instance allocated with BufferUtils.

create

public static VkSubresourceLayout2 create(long address)

Returns a new VkSubresourceLayout2 instance for the specified memory address.

createSafe

public static @Nullable VkSubresourceLayout2 createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSubresourceLayout2.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSubresourceLayout2.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSubresourceLayout2.Buffer create(int capacity)

Returns a new VkSubresourceLayout2.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSubresourceLayout2.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkSubresourceLayout2 instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsubresourceLayout

public static VkSubresourceLayout nsubresourceLayout(long struct)

Unsafe version of subresourceLayout().

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.