Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSubresourceLayout2KHR

extends Struct<VkSubresourceLayout2KHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkSubresourceLayout2EXT
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying subresource layout.
Valid Usage (Implicit)
See Also

VkSubresourceLayout, GetDeviceImageSubresourceLayoutKHR, GetImageSubresourceLayout2EXT, GetImageSubresourceLayout2KHR

Layout


struct VkSubresourceLayout2KHR {
    VkStructureType sType;
    void * pNext;
    VkSubresourceLayout subresourceLayout;
}

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
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

public static final int
SUBRESOURCELAYOUT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkSubresourceLayout2KHR(long address, ByteBuffer container)

public
VkSubresourceLayout2KHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkSubresourceLayout2KHR
calloc()

Returns a new VkSubresourceLayout2KHR instance allocated with memCalloc.

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

Returns a new VkSubresourceLayout2KHR.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkSubresourceLayout2KHR
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 VkSubresourceLayout2KHR
create()

Returns a new VkSubresourceLayout2KHR instance allocated with BufferUtils.

public static VkSubresourceLayout2KHR
create(long address)

Returns a new VkSubresourceLayout2KHR instance for the specified memory address.

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

Returns a new VkSubresourceLayout2KHR.Buffer instance allocated with BufferUtils.

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

Create a VkSubresourceLayout2KHR.Buffer instance at the specified memory.

public static VkSubresourceLayout2KHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkSubresourceLayout2KHR
malloc()

Returns a new VkSubresourceLayout2KHR instance allocated with memAlloc.

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

Returns a new VkSubresourceLayout2KHR.Buffer instance allocated with memAlloc.

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

Returns a new VkSubresourceLayout2KHR instance allocated on the specified MemoryStack.

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

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

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static VkSubresourceLayout
nsubresourceLayout(long struct)

Unsafe version of subresourceLayout.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkSubresourceLayout2KHR
pNext(long value)

Sets the specified value to the pNext field.

public VkSubresourceLayout2KHR
pNext(VkImageCompressionPropertiesEXT value)

Prepends the specified VkImageCompressionPropertiesEXT value to the pNext chain.

public VkSubresourceLayout2KHR
pNext(VkSubresourceHostMemcpySizeEXT value)

Prepends the specified VkSubresourceHostMemcpySizeEXT value to the pNext chain.

public VkSubresourceLayout2KHR
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkSubresourceLayout2KHR

Returns:

this struct
set
(VkSubresourceLayout2KHR
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 VkSubresourceLayout2KHR
sType(int value)

Sets the specified value to the sType field.

public VkSubresourceLayout2KHR
public VkSubresourceLayout
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.

PNEXTback to summary
public static final int PNEXT

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.

SUBRESOURCELAYOUTback to summary
public static final int SUBRESOURCELAYOUT

The struct member offsets.

Constructor Detail

VkSubresourceLayout2KHRback to summary
protected VkSubresourceLayout2KHR(long address, ByteBuffer container)
VkSubresourceLayout2KHRback to summary
public VkSubresourceLayout2KHR(ByteBuffer container)

Creates a VkSubresourceLayout2KHR 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 VkSubresourceLayout2KHR calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSubresourceLayout2KHR calloc(MemoryStack stack)

Returns a new VkSubresourceLayout2KHR 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 VkSubresourceLayout2KHR.Buffer calloc(int capacity, MemoryStack stack)

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

Returns a new VkSubresourceLayout2KHR instance allocated with BufferUtils.

createback to summary
public static VkSubresourceLayout2KHR create(long address)

Returns a new VkSubresourceLayout2KHR instance for the specified memory address.

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

Returns a new VkSubresourceLayout2KHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSubresourceLayout2KHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSubresourceLayout2KHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSubresourceLayout2KHR malloc(MemoryStack stack)

Returns a new VkSubresourceLayout2KHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

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.

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.

nsubresourceLayoutback to summary
public static VkSubresourceLayout nsubresourceLayout(long struct)

Unsafe version of subresourceLayout.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

pNextback to summary
public VkSubresourceLayout2KHR pNext(VkImageCompressionPropertiesEXT value)

Prepends the specified VkImageCompressionPropertiesEXT value to the pNext chain.

pNextback to summary
public VkSubresourceLayout2KHR pNext(VkSubresourceHostMemcpySizeEXT value)

Prepends the specified VkSubresourceHostMemcpySizeEXT value to the pNext chain.

setback to summary
public VkSubresourceLayout2KHR set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkSubresourceLayout2KHR set(VkSubresourceLayout2KHR src)

Copies the specified struct data to this struct.

Parameters
src:VkSubresourceLayout2KHR

the source struct

Returns:VkSubresourceLayout2KHR

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 VkSubresourceLayout2KHR sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_SUBRESOURCE_LAYOUT_2_KHR value to the sType field.

subresourceLayoutback to summary
public VkSubresourceLayout subresourceLayout()

a VkSubresourceLayout structure.

org.lwjgl.vulkan back to summary

public Class VkSubresourceLayout2KHR.Buffer

extends StructBuffer<VkSubresourceLayout2KHR, VkSubresourceLayout2KHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkSubresourceLayout2EXT.Buffer

An array of VkSubresourceLayout2KHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkSubresourceLayout2KHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSubresourceLayout2KHR.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 VkSubresourceLayout2KHR
public long

Returns:

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

public VkSubresourceLayout2KHR.Buffer
pNext(long value)

Sets the specified value to the VkSubresourceLayout2KHR#pNext field.

public VkSubresourceLayout2KHR.Buffer
pNext(VkImageCompressionPropertiesEXT value)

Prepends the specified VkImageCompressionPropertiesEXT value to the pNext chain.

public VkSubresourceLayout2KHR.Buffer
pNext(VkSubresourceHostMemcpySizeEXT value)

Prepends the specified VkSubresourceHostMemcpySizeEXT value to the pNext chain.

protected VkSubresourceLayout2KHR.Buffer
public int

Returns:

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

public VkSubresourceLayout2KHR.Buffer
sType(int value)

Sets the specified value to the VkSubresourceLayout2KHR#sType field.

public VkSubresourceLayout2KHR.Buffer
public VkSubresourceLayout
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSubresourceLayout2KHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkSubresourceLayout2KHR.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 VkSubresourceLayout2KHR#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 VkSubresourceLayout2KHR getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkSubresourceLayout2KHR#pNext field.

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

Sets the specified value to the VkSubresourceLayout2KHR#pNext field.

pNextback to summary
public VkSubresourceLayout2KHR.Buffer pNext(VkImageCompressionPropertiesEXT value)

Prepends the specified VkImageCompressionPropertiesEXT value to the pNext chain.

pNextback to summary
public VkSubresourceLayout2KHR.Buffer pNext(VkSubresourceHostMemcpySizeEXT value)

Prepends the specified VkSubresourceHostMemcpySizeEXT value to the pNext chain.

selfback to summary
protected VkSubresourceLayout2KHR.Buffer self()

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

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

the value of the VkSubresourceLayout2KHR#sType field.

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

Sets the specified value to the VkSubresourceLayout2KHR#sType field.

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

Sets the STRUCTURE_TYPE_SUBRESOURCE_LAYOUT_2_KHR value to the VkSubresourceLayout2KHR#sType field.

subresourceLayoutback to summary
public VkSubresourceLayout subresourceLayout()
Returns:VkSubresourceLayout

a VkSubresourceLayout view of the VkSubresourceLayout2KHR#subresourceLayout field.