Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImageSubresource

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

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

VkImageSubresource2KHR, VkSparseImageMemoryBind, GetImageSubresourceLayout

Layout


struct VkImageSubresource {
    VkImageAspectFlags aspectMask;
    uint32_t mipLevel;
    uint32_t arrayLayer;
}

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
ARRAYLAYER

The struct member offsets.

public static final int
ASPECTMASK

The struct member offsets.

public static final int
MIPLEVEL

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkImageSubresource(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int
arrayLayer()

selects the array layer.

public VkImageSubresource
arrayLayer(int value)

Sets the specified value to the arrayLayer field.

public int
aspectMask()

a VkImageAspectFlags value selecting the image aspect.

public VkImageSubresource
aspectMask(int value)

Sets the specified value to the aspectMask field.

public static VkImageSubresource
calloc()

Returns a new VkImageSubresource instance allocated with memCalloc.

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

Returns a new VkImageSubresource.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkImageSubresource
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageSubresource
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageSubresource.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageSubresource.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkImageSubresource
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 VkImageSubresource
create()

Returns a new VkImageSubresource instance allocated with BufferUtils.

public static VkImageSubresource
create(long address)

Returns a new VkImageSubresource instance for the specified memory address.

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

Returns a new VkImageSubresource.Buffer instance allocated with BufferUtils.

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

Create a VkImageSubresource.Buffer instance at the specified memory.

public static VkImageSubresource
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkImageSubresource
malloc()

Returns a new VkImageSubresource instance allocated with memAlloc.

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

Returns a new VkImageSubresource.Buffer instance allocated with memAlloc.

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

Returns a new VkImageSubresource instance allocated on the specified MemoryStack.

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

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

public static VkImageSubresource
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageSubresource
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageSubresource.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageSubresource.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public int
mipLevel()

selects the mipmap level.

public VkImageSubresource
mipLevel(int value)

Sets the specified value to the mipLevel field.

public static int
narrayLayer(long struct)

Unsafe version of arrayLayer.

public static void
narrayLayer(long struct, int value)

Unsafe version of arrayLayer.

public static int
naspectMask(long struct)

Unsafe version of aspectMask.

public static void
naspectMask(long struct, int value)

Unsafe version of aspectMask.

public static int
nmipLevel(long struct)

Unsafe version of mipLevel.

public static void
nmipLevel(long struct, int value)

Unsafe version of mipLevel.

public VkImageSubresource
set(int aspectMask, int mipLevel, int arrayLayer)

Initializes this struct with the specified values.

public VkImageSubresource

Returns:

this struct
set
(VkImageSubresource
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).
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.

ARRAYLAYERback to summary
public static final int ARRAYLAYER

The struct member offsets.

ASPECTMASKback to summary
public static final int ASPECTMASK

The struct member offsets.

MIPLEVELback to summary
public static final int MIPLEVEL

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkImageSubresourceback to summary
protected VkImageSubresource(long address, ByteBuffer container)
VkImageSubresourceback to summary
public VkImageSubresource(ByteBuffer container)

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

arrayLayerback to summary
public int arrayLayer()

selects the array layer.

Annotations
@NativeType:uint32_t
arrayLayerback to summary
public VkImageSubresource arrayLayer(int value)

Sets the specified value to the arrayLayer field.

aspectMaskback to summary
public int aspectMask()

a VkImageAspectFlags value selecting the image aspect.

Annotations
@NativeType:VkImageAspectFlags
aspectMaskback to summary
public VkImageSubresource aspectMask(int value)

Sets the specified value to the aspectMask field.

callocback to summary
public static VkImageSubresource calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImageSubresource calloc(MemoryStack stack)

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

Returns a new VkImageSubresource.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

callocStackback to summary
public static VkImageSubresource callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkImageSubresource callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkImageSubresource.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkImageSubresource.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkImageSubresource 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 VkImageSubresource create()

Returns a new VkImageSubresource instance allocated with BufferUtils.

createback to summary
public static VkImageSubresource create(long address)

Returns a new VkImageSubresource instance for the specified memory address.

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

Returns a new VkImageSubresource.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkImageSubresource.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImageSubresource createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImageSubresource malloc(MemoryStack stack)

Returns a new VkImageSubresource instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkImageSubresource mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkImageSubresource mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkImageSubresource.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkImageSubresource.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mipLevelback to summary
public int mipLevel()

selects the mipmap level.

Annotations
@NativeType:uint32_t
mipLevelback to summary
public VkImageSubresource mipLevel(int value)

Sets the specified value to the mipLevel field.

narrayLayerback to summary
public static int narrayLayer(long struct)

Unsafe version of arrayLayer.

narrayLayerback to summary
public static void narrayLayer(long struct, int value)

Unsafe version of arrayLayer.

naspectMaskback to summary
public static int naspectMask(long struct)

Unsafe version of aspectMask.

naspectMaskback to summary
public static void naspectMask(long struct, int value)

Unsafe version of aspectMask.

nmipLevelback to summary
public static int nmipLevel(long struct)

Unsafe version of mipLevel.

nmipLevelback to summary
public static void nmipLevel(long struct, int value)

Unsafe version of mipLevel.

setback to summary
public VkImageSubresource set(int aspectMask, int mipLevel, int arrayLayer)

Initializes this struct with the specified values.

setback to summary
public VkImageSubresource set(VkImageSubresource src)

Copies the specified struct data to this struct.

Parameters
src:VkImageSubresource

the source struct

Returns:VkImageSubresource

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
org.lwjgl.vulkan back to summary

public Class VkImageSubresource.Buffer

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

An array of VkImageSubresource structs.

Field Summary

Modifier and TypeField and Description
private static final VkImageSubresource

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkImageSubresource.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
public int

Returns:

the value of the VkImageSubresource#arrayLayer field.
arrayLayer
()

public VkImageSubresource.Buffer
arrayLayer(int value)

Sets the specified value to the VkImageSubresource#arrayLayer field.

public int

Returns:

the value of the VkImageSubresource#aspectMask field.
aspectMask
()

public VkImageSubresource.Buffer
aspectMask(int value)

Sets the specified value to the VkImageSubresource#aspectMask field.

protected VkImageSubresource
public int

Returns:

the value of the VkImageSubresource#mipLevel field.
mipLevel
()

public VkImageSubresource.Buffer
mipLevel(int value)

Sets the specified value to the VkImageSubresource#mipLevel field.

protected VkImageSubresource.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImageSubresource ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkImageSubresource.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 VkImageSubresource#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

arrayLayerback to summary
public int arrayLayer()
Returns:int

the value of the VkImageSubresource#arrayLayer field.

Annotations
@NativeType:uint32_t
arrayLayerback to summary
public VkImageSubresource.Buffer arrayLayer(int value)

Sets the specified value to the VkImageSubresource#arrayLayer field.

aspectMaskback to summary
public int aspectMask()
Returns:int

the value of the VkImageSubresource#aspectMask field.

Annotations
@NativeType:VkImageAspectFlags
aspectMaskback to summary
public VkImageSubresource.Buffer aspectMask(int value)

Sets the specified value to the VkImageSubresource#aspectMask field.

getElementFactoryback to summary
protected VkImageSubresource getElementFactory()

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

Annotations
@Override
mipLevelback to summary
public int mipLevel()
Returns:int

the value of the VkImageSubresource#mipLevel field.

Annotations
@NativeType:uint32_t
mipLevelback to summary
public VkImageSubresource.Buffer mipLevel(int value)

Sets the specified value to the VkImageSubresource#mipLevel field.

selfback to summary
protected VkImageSubresource.Buffer self()

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

Annotations
@Override