Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDeviceImageSubresourceInfoKHR

extends Struct<VkDeviceImageSubresourceInfoKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Image creation information for querying subresource layout.
Valid Usage
Valid Usage (Implicit)
See Also

VkImageCreateInfo, VkImageSubresource2KHR, GetDeviceImageSubresourceLayoutKHR

Layout


struct VkDeviceImageSubresourceInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkImageCreateInfo const * pCreateInfo;
    VkImageSubresource2KHR const * pSubresource;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PCREATEINFO

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
PSUBRESOURCE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkDeviceImageSubresourceInfoKHR(ByteBuffer container)

Creates a VkDeviceImageSubresourceInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkDeviceImageSubresourceInfoKHR
calloc()

Returns a new VkDeviceImageSubresourceInfoKHR instance allocated with memCalloc.

public static VkDeviceImageSubresourceInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkDeviceImageSubresourceInfoKHR.Buffer instance allocated with memCalloc.

public static VkDeviceImageSubresourceInfoKHR
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkDeviceImageSubresourceInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VkDeviceImageSubresourceInfoKHR
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkDeviceImageSubresourceInfoKHR
create()

Returns a new VkDeviceImageSubresourceInfoKHR instance allocated with BufferUtils.

public static VkDeviceImageSubresourceInfoKHR
create(long address)

Returns a new VkDeviceImageSubresourceInfoKHR instance for the specified memory address.

public static VkDeviceImageSubresourceInfoKHR.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkDeviceImageSubresourceInfoKHR.Buffer instance allocated with BufferUtils.

public static VkDeviceImageSubresourceInfoKHR.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkDeviceImageSubresourceInfoKHR.Buffer instance at the specified memory.

public static VkDeviceImageSubresourceInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkDeviceImageSubresourceInfoKHR.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkDeviceImageSubresourceInfoKHR
malloc()

Returns a new VkDeviceImageSubresourceInfoKHR instance allocated with memAlloc.

public static VkDeviceImageSubresourceInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkDeviceImageSubresourceInfoKHR.Buffer instance allocated with memAlloc.

public static VkDeviceImageSubresourceInfoKHR
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkDeviceImageSubresourceInfoKHR instance allocated on the specified MemoryStack.

public static VkDeviceImageSubresourceInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkImageCreateInfo
npCreateInfo(long struct)

Unsafe version of pCreateInfo.

public static void
npCreateInfo(long struct, VkImageCreateInfo value)

Unsafe version of pCreateInfo.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static VkImageSubresource2KHR
npSubresource(long struct)

Unsafe version of pSubresource.

public static void
npSubresource(long struct, VkImageSubresource2KHR value)

Unsafe version of pSubresource.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public VkImageCreateInfo
pCreateInfo()

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

public VkDeviceImageSubresourceInfoKHR
pCreateInfo(VkImageCreateInfo value)

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

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkDeviceImageSubresourceInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkImageSubresource2KHR
pSubresource()

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

public VkDeviceImageSubresourceInfoKHR
pSubresource(VkImageSubresource2KHR value)

Sets the address of the specified VkImageSubresource2KHR to the pSubresource field.

public VkDeviceImageSubresourceInfoKHR
set(int sType, long pNext, VkImageCreateInfo pCreateInfo, VkImageSubresource2KHR pSubresource)

Initializes this struct with the specified values.

public VkDeviceImageSubresourceInfoKHR

Returns:

this struct
set
(VkDeviceImageSubresourceInfoKHR
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkDeviceImageSubresourceInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkDeviceImageSubresourceInfoKHR
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PCREATEINFOback to summary
public static final int PCREATEINFO

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PSUBRESOURCEback to summary
public static final int PSUBRESOURCE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkDeviceImageSubresourceInfoKHRback to summary
protected VkDeviceImageSubresourceInfoKHR(long address, ByteBuffer container)
VkDeviceImageSubresourceInfoKHRback to summary
public VkDeviceImageSubresourceInfoKHR(ByteBuffer container)

Creates a VkDeviceImageSubresourceInfoKHR 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 Detail

callocback to summary
public static VkDeviceImageSubresourceInfoKHR calloc()

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

callocback to summary
public static VkDeviceImageSubresourceInfoKHR.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDeviceImageSubresourceInfoKHR calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkDeviceImageSubresourceInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkDeviceImageSubresourceInfoKHR create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkDeviceImageSubresourceInfoKHR create()

Returns a new VkDeviceImageSubresourceInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkDeviceImageSubresourceInfoKHR create(long address)

Returns a new VkDeviceImageSubresourceInfoKHR instance for the specified memory address.

createback to summary
public static VkDeviceImageSubresourceInfoKHR.Buffer create(int capacity)

Returns a new VkDeviceImageSubresourceInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkDeviceImageSubresourceInfoKHR.Buffer create(long address, int capacity)

Create a VkDeviceImageSubresourceInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDeviceImageSubresourceInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkDeviceImageSubresourceInfoKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkDeviceImageSubresourceInfoKHR malloc()

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

mallocback to summary
public static VkDeviceImageSubresourceInfoKHR.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDeviceImageSubresourceInfoKHR malloc(MemoryStack stack)

Returns a new VkDeviceImageSubresourceInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkDeviceImageSubresourceInfoKHR.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

npCreateInfoback to summary
public static VkImageCreateInfo npCreateInfo(long struct)

Unsafe version of pCreateInfo.

npCreateInfoback to summary
public static void npCreateInfo(long struct, VkImageCreateInfo value)

Unsafe version of pCreateInfo.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

npSubresourceback to summary
public static VkImageSubresource2KHR npSubresource(long struct)

Unsafe version of pSubresource.

npSubresourceback to summary
public static void npSubresource(long struct, VkImageSubresource2KHR value)

Unsafe version of pSubresource.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pCreateInfoback to summary
public VkImageCreateInfo pCreateInfo()

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

Annotations
@NativeType:VkImageCreateInfo const *
pCreateInfoback to summary
public VkDeviceImageSubresourceInfoKHR pCreateInfo(VkImageCreateInfo value)

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

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkDeviceImageSubresourceInfoKHR pNext(long value)

Sets the specified value to the pNext field.

pSubresourceback to summary
public VkImageSubresource2KHR pSubresource()

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

Annotations
@NativeType:VkImageSubresource2KHR const *
pSubresourceback to summary
public VkDeviceImageSubresourceInfoKHR pSubresource(VkImageSubresource2KHR value)

Sets the address of the specified VkImageSubresource2KHR to the pSubresource field.

setback to summary
public VkDeviceImageSubresourceInfoKHR set(int sType, long pNext, VkImageCreateInfo pCreateInfo, VkImageSubresource2KHR pSubresource)

Initializes this struct with the specified values.

setback to summary
public VkDeviceImageSubresourceInfoKHR set(VkDeviceImageSubresourceInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkDeviceImageSubresourceInfoKHR

the source struct

Returns:VkDeviceImageSubresourceInfoKHR

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkDeviceImageSubresourceInfoKHR sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkDeviceImageSubresourceInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_IMAGE_SUBRESOURCE_INFO_KHR value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkDeviceImageSubresourceInfoKHR.Buffer

extends StructBuffer<VkDeviceImageSubresourceInfoKHR, VkDeviceImageSubresourceInfoKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkDeviceImageSubresourceInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkDeviceImageSubresourceInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDeviceImageSubresourceInfoKHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkDeviceImageSubresourceInfoKHR
public VkImageCreateInfo

Returns:

a VkImageCreateInfo view of the struct pointed to by the VkDeviceImageSubresourceInfoKHR#pCreateInfo field.
pCreateInfo
()

public VkDeviceImageSubresourceInfoKHR.Buffer
public long

Returns:

the value of the VkDeviceImageSubresourceInfoKHR#pNext field.
pNext
()

public VkDeviceImageSubresourceInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkDeviceImageSubresourceInfoKHR#pNext field.

public VkImageSubresource2KHR

Returns:

a VkImageSubresource2KHR view of the struct pointed to by the VkDeviceImageSubresourceInfoKHR#pSubresource field.
pSubresource
()

public VkDeviceImageSubresourceInfoKHR.Buffer
protected VkDeviceImageSubresourceInfoKHR.Buffer
public int

Returns:

the value of the VkDeviceImageSubresourceInfoKHR#sType field.
sType
()

public VkDeviceImageSubresourceInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkDeviceImageSubresourceInfoKHR#sType field.

public VkDeviceImageSubresourceInfoKHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDeviceImageSubresourceInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkDeviceImageSubresourceInfoKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkDeviceImageSubresourceInfoKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkDeviceImageSubresourceInfoKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pCreateInfoback to summary
public VkImageCreateInfo pCreateInfo()
Returns:VkImageCreateInfo

a VkImageCreateInfo view of the struct pointed to by the VkDeviceImageSubresourceInfoKHR#pCreateInfo field.

Annotations
@NativeType:VkImageCreateInfo const *
pCreateInfoback to summary
public VkDeviceImageSubresourceInfoKHR.Buffer pCreateInfo(VkImageCreateInfo value)

Sets the address of the specified VkImageCreateInfo to the VkDeviceImageSubresourceInfoKHR#pCreateInfo field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkDeviceImageSubresourceInfoKHR#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkDeviceImageSubresourceInfoKHR.Buffer pNext(long value)

Sets the specified value to the VkDeviceImageSubresourceInfoKHR#pNext field.

pSubresourceback to summary
public VkImageSubresource2KHR pSubresource()
Returns:VkImageSubresource2KHR

a VkImageSubresource2KHR view of the struct pointed to by the VkDeviceImageSubresourceInfoKHR#pSubresource field.

Annotations
@NativeType:VkImageSubresource2KHR const *
pSubresourceback to summary
public VkDeviceImageSubresourceInfoKHR.Buffer pSubresource(VkImageSubresource2KHR value)

Sets the address of the specified VkImageSubresource2KHR to the VkDeviceImageSubresourceInfoKHR#pSubresource field.

selfback to summary
protected VkDeviceImageSubresourceInfoKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkDeviceImageSubresourceInfoKHR#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkDeviceImageSubresourceInfoKHR.Buffer sType(int value)

Sets the specified value to the VkDeviceImageSubresourceInfoKHR#sType field.

sType$Defaultback to summary
public VkDeviceImageSubresourceInfoKHR.Buffer sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_IMAGE_SUBRESOURCE_INFO_KHR value to the VkDeviceImageSubresourceInfoKHR#sType field.