Package org.lwjgl.vulkan

Class VkDeviceImageSubresourceInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDeviceImageSubresourceInfo>

org.lwjgl.vulkan.VkDeviceImageSubresourceInfo

All Implemented Interfaces:

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

Direct Known Subclasses:

VkDeviceImageSubresourceInfoKHR

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

Image creation information for querying subresource layout.

Valid Usage

• The aspectMask member of pSubresource must only have a single bit set
• The mipLevel member of pSubresource must be less than the mipLevels specified in pCreateInfo
• The arrayLayer member of pSubresource must be less than the arrayLayers specified in pCreateInfo
• If format of the image is a color format that is not a multi-planar image format, and tiling of the pCreateInfo is IMAGE_TILING_LINEAR or IMAGE_TILING_OPTIMAL, the aspectMask member of pSubresource must be IMAGE_ASPECT_COLOR_BIT
• If format of the pCreateInfo has a depth component, the aspectMask member of pSubresource must contain IMAGE_ASPECT_DEPTH_BIT
• If format of the pCreateInfo has a stencil component, the aspectMask member of pSubresource must contain IMAGE_ASPECT_STENCIL_BIT
• If format of the pCreateInfo does not contain a stencil or depth component, the aspectMask member of pSubresource must not contain IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
• If the tiling of the pCreateInfo is IMAGE_TILING_LINEAR and has a multi-planar image format, then the aspectMask member of pSubresource must be a single valid multi-planar aspect mask bit

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEVICE_IMAGE_SUBRESOURCE_INFO
• pNext must be NULL
• pCreateInfo must be a valid pointer to a valid VkImageCreateInfo structure
• pSubresource must be a valid pointer to a valid VkImageSubresource2 structure

See Also

VkImageCreateInfo, VkImageSubresource2, GetDeviceImageSubresourceLayout, GetDeviceImageSubresourceLayoutKHR

Layout

 struct VkDeviceImageSubresourceInfo {
     VkStructureType sType();
     void const * pNext();
     VkImageCreateInfo const * pCreateInfo();
     VkImageSubresource2 const * pSubresource();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkDeviceImageSubresourceInfo	calloc()	Returns a new VkDeviceImageSubresourceInfo instance allocated with memCalloc.
static VkDeviceImageSubresourceInfo.Buffer	calloc(int capacity)	Returns a new VkDeviceImageSubresourceInfo.Buffer instance allocated with memCalloc.
static VkDeviceImageSubresourceInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceImageSubresourceInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceImageSubresourceInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceImageSubresourceInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceImageSubresourceInfo	create()	Returns a new VkDeviceImageSubresourceInfo instance allocated with BufferUtils.
static VkDeviceImageSubresourceInfo.Buffer	create(int capacity)	Returns a new VkDeviceImageSubresourceInfo.Buffer instance allocated with BufferUtils.
static VkDeviceImageSubresourceInfo	create(long address)	Returns a new VkDeviceImageSubresourceInfo instance for the specified memory address.
static VkDeviceImageSubresourceInfo.Buffer	create(long address, int capacity)	Create a VkDeviceImageSubresourceInfo.Buffer instance at the specified memory.
static @Nullable VkDeviceImageSubresourceInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDeviceImageSubresourceInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkDeviceImageSubresourceInfo	malloc()	Returns a new VkDeviceImageSubresourceInfo instance allocated with memAlloc.
static VkDeviceImageSubresourceInfo.Buffer	malloc(int capacity)	Returns a new VkDeviceImageSubresourceInfo.Buffer instance allocated with memAlloc.
static VkDeviceImageSubresourceInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceImageSubresourceInfo.Buffer instance allocated on the specified MemoryStack.
static VkDeviceImageSubresourceInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceImageSubresourceInfo instance allocated on the specified MemoryStack.
static VkImageCreateInfo	npCreateInfo(long struct)	Unsafe version of pCreateInfo().
static void	npCreateInfo(long struct, VkImageCreateInfo value)	Unsafe version of pCreateInfo.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static VkImageSubresource2	npSubresource(long struct)	Unsafe version of pSubresource().
static void	npSubresource(long struct, VkImageSubresource2 value)	Unsafe version of pSubresource.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
VkImageCreateInfo	pCreateInfo()	a pointer to a VkImageCreateInfo structure containing parameters affecting creation of the image to query.
VkDeviceImageSubresourceInfo	pCreateInfo(VkImageCreateInfo value)	Sets the address of the specified VkImageCreateInfo to the pCreateInfo() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkDeviceImageSubresourceInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkImageSubresource2	pSubresource()	pSubresource is a pointer to a VkImageSubresource2 structure selecting a specific image subresource for the query.
VkDeviceImageSubresourceInfo	pSubresource(VkImageSubresource2 value)	Sets the address of the specified VkImageSubresource2 to the pSubresource() field.
VkDeviceImageSubresourceInfo	set(int sType, long pNext, VkImageCreateInfo pCreateInfo, VkImageSubresource2 pSubresource)	Initializes this struct with the specified values.
VkDeviceImageSubresourceInfo	set(VkDeviceImageSubresourceInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkDeviceImageSubresourceInfo	sType(int value)	Sets the specified value to the sType() field.
VkDeviceImageSubresourceInfo	sType$Default()	Sets the STRUCTURE_TYPE_DEVICE_IMAGE_SUBRESOURCE_INFO 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.

PCREATEINFO

public static final int PCREATEINFO

The struct member offsets.

PSUBRESOURCE

public static final int PSUBRESOURCE

The struct member offsets.

Constructor Details

VkDeviceImageSubresourceInfo

public VkDeviceImageSubresourceInfo(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

pCreateInfo

public VkImageCreateInfo pCreateInfo()

a pointer to a VkImageCreateInfo structure containing parameters affecting creation of the image to query.

pSubresource

public VkImageSubresource2 pSubresource()

pSubresource is a pointer to a VkImageSubresource2 structure selecting a specific image subresource for the query.

sType

public VkDeviceImageSubresourceInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDeviceImageSubresourceInfo sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_IMAGE_SUBRESOURCE_INFO value to the sType() field.

pNext

public VkDeviceImageSubresourceInfo pNext(long value)

Sets the specified value to the pNext() field.

pCreateInfo

public VkDeviceImageSubresourceInfo pCreateInfo(VkImageCreateInfo value)

Sets the address of the specified VkImageCreateInfo to the pCreateInfo() field.

pSubresource

public VkDeviceImageSubresourceInfo pSubresource(VkImageSubresource2 value)

Sets the address of the specified VkImageSubresource2 to the pSubresource() field.

set

public VkDeviceImageSubresourceInfo set(int sType,
 long pNext,
 VkImageCreateInfo pCreateInfo,
 VkImageSubresource2 pSubresource)

Initializes this struct with the specified values.

set

public VkDeviceImageSubresourceInfo set(VkDeviceImageSubresourceInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDeviceImageSubresourceInfo malloc()

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

calloc

public static VkDeviceImageSubresourceInfo calloc()

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

create

public static VkDeviceImageSubresourceInfo create()

Returns a new VkDeviceImageSubresourceInfo instance allocated with BufferUtils.

create

public static VkDeviceImageSubresourceInfo create(long address)

Returns a new VkDeviceImageSubresourceInfo instance for the specified memory address.

createSafe

public static @Nullable VkDeviceImageSubresourceInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDeviceImageSubresourceInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDeviceImageSubresourceInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDeviceImageSubresourceInfo.Buffer create(int capacity)

Returns a new VkDeviceImageSubresourceInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDeviceImageSubresourceInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkDeviceImageSubresourceInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npCreateInfo

public static VkImageCreateInfo npCreateInfo(long struct)

Unsafe version of pCreateInfo().

npSubresource

public static VkImageSubresource2 npSubresource(long struct)

Unsafe version of pSubresource().

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.

npCreateInfo

public static void npCreateInfo(long struct,
 VkImageCreateInfo value)

Unsafe version of pCreateInfo.

npSubresource

public static void npSubresource(long struct,
 VkImageSubresource2 value)

Unsafe version of pSubresource.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate