Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImageSubresource2KHR

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

Structure specifying an image subresource.
Valid Usage (Implicit)
See Also

VkDeviceImageSubresourceInfoKHR, VkImageSubresource, GetImageSubresourceLayout2EXT, GetImageSubresourceLayout2KHR

Layout


struct VkImageSubresource2KHR {
    VkStructureType sType;
    void * pNext;
    VkImageSubresource imageSubresource;
}

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
IMAGESUBRESOURCE

The struct member offsets.

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.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkImageSubresource2KHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkImageSubresource2KHR
calloc()

Returns a new VkImageSubresource2KHR instance allocated with memCalloc.

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

Returns a new VkImageSubresource2KHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkImageSubresource2KHR instance allocated with BufferUtils.

public static VkImageSubresource2KHR
create(long address)

Returns a new VkImageSubresource2KHR instance for the specified memory address.

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

Returns a new VkImageSubresource2KHR.Buffer instance allocated with BufferUtils.

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

Create a VkImageSubresource2KHR.Buffer instance at the specified memory.

public static VkImageSubresource2KHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public VkImageSubresource
public VkImageSubresource2KHR
public VkImageSubresource2KHR
imageSubresource(Consumer<VkImageSubresource> consumer)

Passes the imageSubresource field to the specified Consumer.

public static VkImageSubresource2KHR
malloc()

Returns a new VkImageSubresource2KHR instance allocated with memAlloc.

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

Returns a new VkImageSubresource2KHR.Buffer instance allocated with memAlloc.

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

Returns a new VkImageSubresource2KHR instance allocated on the specified MemoryStack.

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

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

public static VkImageSubresource
nimageSubresource(long struct)

Unsafe version of imageSubresource.

public static void
nimageSubresource(long struct, VkImageSubresource value)

Unsafe version of imageSubresource.

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 long
pNext()

NULL or a pointer to a structure extending this structure.

public VkImageSubresource2KHR
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkImageSubresource2KHR

Returns:

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

Sets the specified value to the sType field.

public VkImageSubresource2KHR
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.

IMAGESUBRESOURCEback to summary
public static final int IMAGESUBRESOURCE

The struct member offsets.

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.

Constructor Detail

VkImageSubresource2KHRback to summary
protected VkImageSubresource2KHR(long address, ByteBuffer container)
VkImageSubresource2KHRback to summary
public VkImageSubresource2KHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImageSubresource2KHR calloc(MemoryStack stack)

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

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

Returns a new VkImageSubresource2KHR instance allocated with BufferUtils.

createback to summary
public static VkImageSubresource2KHR create(long address)

Returns a new VkImageSubresource2KHR instance for the specified memory address.

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

Returns a new VkImageSubresource2KHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkImageSubresource2KHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImageSubresource2KHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
imageSubresourceback to summary
public VkImageSubresource imageSubresource()

a VkImageSubresource structure.

imageSubresourceback to summary
public VkImageSubresource2KHR imageSubresource(VkImageSubresource value)

Copies the specified VkImageSubresource to the imageSubresource field.

imageSubresourceback to summary
public VkImageSubresource2KHR imageSubresource(Consumer<VkImageSubresource> consumer)

Passes the imageSubresource field to the specified Consumer.

mallocback to summary
public static VkImageSubresource2KHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImageSubresource2KHR malloc(MemoryStack stack)

Returns a new VkImageSubresource2KHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nimageSubresourceback to summary
public static VkImageSubresource nimageSubresource(long struct)

Unsafe version of imageSubresource.

nimageSubresourceback to summary
public static void nimageSubresource(long struct, VkImageSubresource value)

Unsafe version of imageSubresource.

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkImageSubresource2KHR set(int sType, long pNext, VkImageSubresource imageSubresource)

Initializes this struct with the specified values.

setback to summary
public VkImageSubresource2KHR set(VkImageSubresource2KHR src)

Copies the specified struct data to this struct.

Parameters
src:VkImageSubresource2KHR

the source struct

Returns:VkImageSubresource2KHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_IMAGE_SUBRESOURCE_2_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkImageSubresource2KHR.Buffer

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

An array of VkImageSubresource2KHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkImageSubresource2KHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkImageSubresource2KHR.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 VkImageSubresource2KHR
public VkImageSubresource
public VkImageSubresource2KHR.Buffer
public VkImageSubresource2KHR.Buffer
public long

Returns:

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

public VkImageSubresource2KHR.Buffer
pNext(long value)

Sets the specified value to the VkImageSubresource2KHR#pNext field.

protected VkImageSubresource2KHR.Buffer
public int

Returns:

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

public VkImageSubresource2KHR.Buffer
sType(int value)

Sets the specified value to the VkImageSubresource2KHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImageSubresource2KHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
imageSubresourceback to summary
public VkImageSubresource imageSubresource()
Returns:VkImageSubresource

a VkImageSubresource view of the VkImageSubresource2KHR#imageSubresource field.

imageSubresourceback to summary
public VkImageSubresource2KHR.Buffer imageSubresource(VkImageSubresource value)

Copies the specified VkImageSubresource to the VkImageSubresource2KHR#imageSubresource field.

imageSubresourceback to summary
public VkImageSubresource2KHR.Buffer imageSubresource(Consumer<VkImageSubresource> consumer)

Passes the VkImageSubresource2KHR#imageSubresource field to the specified Consumer.

pNextback to summary
public long pNext()
Returns:long

the value of the VkImageSubresource2KHR#pNext field.

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

Sets the specified value to the VkImageSubresource2KHR#pNext field.

selfback to summary
protected VkImageSubresource2KHR.Buffer self()

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

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

the value of the VkImageSubresource2KHR#sType field.

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

Sets the specified value to the VkImageSubresource2KHR#sType field.

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

Sets the STRUCTURE_TYPE_IMAGE_SUBRESOURCE_2_KHR value to the VkImageSubresource2KHR#sType field.