Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImageSubresourceLayers

extends Struct<VkImageSubresourceLayers>
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 layers.
Valid Usage
Valid Usage (Implicit)
See Also

VkBufferImageCopy, VkBufferImageCopy2, VkCopyMemoryToImageIndirectCommandNV, VkImageBlit, VkImageBlit2, VkImageCopy, VkImageCopy2, VkImageResolve, VkImageResolve2, VkImageToMemoryCopyEXT, VkMemoryToImageCopyEXT, CmdCopyMemoryToImageIndirectNV

Layout


struct VkImageSubresourceLayers {
    VkImageAspectFlags aspectMask;
    uint32_t mipLevel;
    uint32_t baseArrayLayer;
    uint32_t layerCount;
}

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
ASPECTMASK

The struct member offsets.

public static final int
BASEARRAYLAYER

The struct member offsets.

public static final int
LAYERCOUNT

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
VkImageSubresourceLayers(long address, ByteBuffer container)

public
VkImageSubresourceLayers(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int
aspectMask()

a combination of VkImageAspectFlagBits, selecting the color, depth and/or stencil aspects to be copied.

public VkImageSubresourceLayers
aspectMask(int value)

Sets the specified value to the aspectMask field.

public int
baseArrayLayer()

baseArrayLayer and layerCount are the starting layer and number of layers to copy.

public VkImageSubresourceLayers
baseArrayLayer(int value)

Sets the specified value to the baseArrayLayer field.

public static VkImageSubresourceLayers
calloc()

Returns a new VkImageSubresourceLayers instance allocated with memCalloc.

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

Returns a new VkImageSubresourceLayers.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkImageSubresourceLayers
callocStack()

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

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

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

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

Returns a new VkImageSubresourceLayers instance allocated with BufferUtils.

public static VkImageSubresourceLayers
create(long address)

Returns a new VkImageSubresourceLayers instance for the specified memory address.

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

Returns a new VkImageSubresourceLayers.Buffer instance allocated with BufferUtils.

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

Create a VkImageSubresourceLayers.Buffer instance at the specified memory.

public static VkImageSubresourceLayers
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
layerCount()

see baseArrayLayer

public VkImageSubresourceLayers
layerCount(int value)

Sets the specified value to the layerCount field.

public static VkImageSubresourceLayers
malloc()

Returns a new VkImageSubresourceLayers instance allocated with memAlloc.

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

Returns a new VkImageSubresourceLayers.Buffer instance allocated with memAlloc.

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

Returns a new VkImageSubresourceLayers instance allocated on the specified MemoryStack.

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

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

public static VkImageSubresourceLayers
mallocStack()

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

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

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

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

the mipmap level to copy

public VkImageSubresourceLayers
mipLevel(int value)

Sets the specified value to the mipLevel field.

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
nbaseArrayLayer(long struct)

Unsafe version of baseArrayLayer.

public static void
nbaseArrayLayer(long struct, int value)

Unsafe version of baseArrayLayer.

public static int
nlayerCount(long struct)

Unsafe version of layerCount.

public static void
nlayerCount(long struct, int value)

Unsafe version of layerCount.

public static int
nmipLevel(long struct)

Unsafe version of mipLevel.

public static void
nmipLevel(long struct, int value)

Unsafe version of mipLevel.

public VkImageSubresourceLayers
set(int aspectMask, int mipLevel, int baseArrayLayer, int layerCount)

Initializes this struct with the specified values.

public VkImageSubresourceLayers

Returns:

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

ASPECTMASKback to summary
public static final int ASPECTMASK

The struct member offsets.

BASEARRAYLAYERback to summary
public static final int BASEARRAYLAYER

The struct member offsets.

LAYERCOUNTback to summary
public static final int LAYERCOUNT

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

VkImageSubresourceLayersback to summary
protected VkImageSubresourceLayers(long address, ByteBuffer container)
VkImageSubresourceLayersback to summary
public VkImageSubresourceLayers(ByteBuffer container)

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

aspectMaskback to summary
public int aspectMask()

a combination of VkImageAspectFlagBits, selecting the color, depth and/or stencil aspects to be copied.

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

Sets the specified value to the aspectMask field.

baseArrayLayerback to summary
public int baseArrayLayer()

baseArrayLayer and layerCount are the starting layer and number of layers to copy.

Annotations
@NativeType:uint32_t
baseArrayLayerback to summary
public VkImageSubresourceLayers baseArrayLayer(int value)

Sets the specified value to the baseArrayLayer field.

callocback to summary
public static VkImageSubresourceLayers calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImageSubresourceLayers calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkImageSubresourceLayers.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 VkImageSubresourceLayers 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 VkImageSubresourceLayers create()

Returns a new VkImageSubresourceLayers instance allocated with BufferUtils.

createback to summary
public static VkImageSubresourceLayers create(long address)

Returns a new VkImageSubresourceLayers instance for the specified memory address.

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

Returns a new VkImageSubresourceLayers.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkImageSubresourceLayers.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImageSubresourceLayers createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
layerCountback to summary
public int layerCount()

see baseArrayLayer

Annotations
@NativeType:uint32_t
layerCountback to summary
public VkImageSubresourceLayers layerCount(int value)

Sets the specified value to the layerCount field.

mallocback to summary
public static VkImageSubresourceLayers malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImageSubresourceLayers malloc(MemoryStack stack)

Returns a new VkImageSubresourceLayers instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkImageSubresourceLayers.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()

the mipmap level to copy

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

Sets the specified value to the mipLevel field.

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.

nbaseArrayLayerback to summary
public static int nbaseArrayLayer(long struct)

Unsafe version of baseArrayLayer.

nbaseArrayLayerback to summary
public static void nbaseArrayLayer(long struct, int value)

Unsafe version of baseArrayLayer.

nlayerCountback to summary
public static int nlayerCount(long struct)

Unsafe version of layerCount.

nlayerCountback to summary
public static void nlayerCount(long struct, int value)

Unsafe version of layerCount.

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 VkImageSubresourceLayers set(int aspectMask, int mipLevel, int baseArrayLayer, int layerCount)

Initializes this struct with the specified values.

setback to summary
public VkImageSubresourceLayers set(VkImageSubresourceLayers src)

Copies the specified struct data to this struct.

Parameters
src:VkImageSubresourceLayers

the source struct

Returns:VkImageSubresourceLayers

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 VkImageSubresourceLayers.Buffer

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

An array of VkImageSubresourceLayers structs.

Field Summary

Modifier and TypeField and Description
private static final VkImageSubresourceLayers

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkImageSubresourceLayers.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 VkImageSubresourceLayers#aspectMask field.
aspectMask
()

public VkImageSubresourceLayers.Buffer
aspectMask(int value)

Sets the specified value to the VkImageSubresourceLayers#aspectMask field.

public int

Returns:

the value of the VkImageSubresourceLayers#baseArrayLayer field.
baseArrayLayer
()

public VkImageSubresourceLayers.Buffer
baseArrayLayer(int value)

Sets the specified value to the VkImageSubresourceLayers#baseArrayLayer field.

protected VkImageSubresourceLayers
public int

Returns:

the value of the VkImageSubresourceLayers#layerCount field.
layerCount
()

public VkImageSubresourceLayers.Buffer
layerCount(int value)

Sets the specified value to the VkImageSubresourceLayers#layerCount field.

public int

Returns:

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

public VkImageSubresourceLayers.Buffer
mipLevel(int value)

Sets the specified value to the VkImageSubresourceLayers#mipLevel field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImageSubresourceLayers ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

aspectMaskback to summary
public int aspectMask()
Returns:int

the value of the VkImageSubresourceLayers#aspectMask field.

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

Sets the specified value to the VkImageSubresourceLayers#aspectMask field.

baseArrayLayerback to summary
public int baseArrayLayer()
Returns:int

the value of the VkImageSubresourceLayers#baseArrayLayer field.

Annotations
@NativeType:uint32_t
baseArrayLayerback to summary
public VkImageSubresourceLayers.Buffer baseArrayLayer(int value)

Sets the specified value to the VkImageSubresourceLayers#baseArrayLayer field.

getElementFactoryback to summary
protected VkImageSubresourceLayers getElementFactory()

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

Annotations
@Override
layerCountback to summary
public int layerCount()
Returns:int

the value of the VkImageSubresourceLayers#layerCount field.

Annotations
@NativeType:uint32_t
layerCountback to summary
public VkImageSubresourceLayers.Buffer layerCount(int value)

Sets the specified value to the VkImageSubresourceLayers#layerCount field.

mipLevelback to summary
public int mipLevel()
Returns:int

the value of the VkImageSubresourceLayers#mipLevel field.

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

Sets the specified value to the VkImageSubresourceLayers#mipLevel field.

selfback to summary
protected VkImageSubresourceLayers.Buffer self()

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

Annotations
@Override