VkImageSubresourceLayers (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkImageSubresourceLayers

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkImageSubresourceLayers
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying an image subresource layers.
Valid Usage
- If aspectMask contains IMAGE_ASPECT_COLOR_BIT, it must not contain either of IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
- aspectMask must not contain IMAGE_ASPECT_METADATA_BIT
- aspectMask must not include VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT for any index i.
- layerCount must be greater than 0
Valid Usage (Implicit)
- aspectMask must be a valid combination of VkImageAspectFlagBits values
- aspectMask must not be 0
See Also

VkBufferImageCopy, VkImageBlit, VkImageCopy, VkImageResolve

Member documentation
- aspectMask – a combination of VkImageAspectFlagBits, selecting the color, depth and/or stencil aspects to be copied.
- mipLevel – the mipmap level to copy from.
- baseArrayLayer – baseArrayLayer and layerCount are the starting layer and number of layers to copy.
- layerCount – see baseArrayLayer
Layout
```
 struct VkImageSubresourceLayers {
     VkImageAspectFlags aspectMask;
     uint32_t mipLevel;
     uint32_t baseArrayLayer;
     uint32_t layerCount;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkImageSubresourceLayers.Buffer
An array of VkImageSubresourceLayers structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkImageSubresourceLayers.Buffer` An array of `VkImageSubresourceLayers` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ASPECTMASK` The struct member offsets.
`static int`	`BASEARRAYLAYER` The struct member offsets.
`static int`	`LAYERCOUNT` The struct member offsets.
`static int`	`MIPLEVEL` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkImageSubresourceLayers(java.nio.ByteBuffer container)` Creates a `VkImageSubresourceLayers` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`aspectMask()` Returns the value of the `aspectMask` field.
`VkImageSubresourceLayers`	`aspectMask(int value)` Sets the specified value to the `aspectMask` field.
`int`	`baseArrayLayer()` Returns the value of the `baseArrayLayer` field.
`VkImageSubresourceLayers`	`baseArrayLayer(int value)` Sets the specified value to the `baseArrayLayer` field.
`static VkImageSubresourceLayers`	`calloc()` Returns a new `VkImageSubresourceLayers` instance allocated with `memCalloc`.
`static VkImageSubresourceLayers.Buffer`	`calloc(int capacity)` Returns a new `VkImageSubresourceLayers.Buffer` instance allocated with `memCalloc`.
`static VkImageSubresourceLayers`	`callocStack()` Returns a new `VkImageSubresourceLayers` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageSubresourceLayers.Buffer`	`callocStack(int capacity)` Returns a new `VkImageSubresourceLayers.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageSubresourceLayers.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageSubresourceLayers.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageSubresourceLayers`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageSubresourceLayers` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageSubresourceLayers`	`create()` Returns a new `VkImageSubresourceLayers` instance allocated with `BufferUtils`.
`static VkImageSubresourceLayers.Buffer`	`create(int capacity)` Returns a new `VkImageSubresourceLayers.Buffer` instance allocated with `BufferUtils`.
`static VkImageSubresourceLayers`	`create(long address)` Returns a new `VkImageSubresourceLayers` instance for the specified memory address.
`static VkImageSubresourceLayers.Buffer`	`create(long address, int capacity)` Create a `VkImageSubresourceLayers.Buffer` instance at the specified memory.
`static VkImageSubresourceLayers`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkImageSubresourceLayers.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`layerCount()` Returns the value of the `layerCount` field.
`VkImageSubresourceLayers`	`layerCount(int value)` Sets the specified value to the `layerCount` field.
`static VkImageSubresourceLayers`	`malloc()` Returns a new `VkImageSubresourceLayers` instance allocated with `memAlloc`.
`static VkImageSubresourceLayers.Buffer`	`malloc(int capacity)` Returns a new `VkImageSubresourceLayers.Buffer` instance allocated with `memAlloc`.
`static VkImageSubresourceLayers`	`mallocStack()` Returns a new `VkImageSubresourceLayers` instance allocated on the thread-local `MemoryStack`.
`static VkImageSubresourceLayers.Buffer`	`mallocStack(int capacity)` Returns a new `VkImageSubresourceLayers.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkImageSubresourceLayers.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageSubresourceLayers.Buffer` instance allocated on the specified `MemoryStack`.
`static VkImageSubresourceLayers`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageSubresourceLayers` instance allocated on the specified `MemoryStack`.
`int`	`mipLevel()` Returns the value of the `mipLevel` field.
`VkImageSubresourceLayers`	`mipLevel(int value)` Sets the specified value to the `mipLevel` field.
`static int`	`naspectMask(long struct)` Unsafe version of `aspectMask()`.
`static void`	`naspectMask(long struct, int value)` Unsafe version of `aspectMask`.
`static int`	`nbaseArrayLayer(long struct)` Unsafe version of `baseArrayLayer()`.
`static void`	`nbaseArrayLayer(long struct, int value)` Unsafe version of `baseArrayLayer`.
`static int`	`nlayerCount(long struct)` Unsafe version of `layerCount()`.
`static void`	`nlayerCount(long struct, int value)` Unsafe version of `layerCount`.
`static int`	`nmipLevel(long struct)` Unsafe version of `mipLevel()`.
`static void`	`nmipLevel(long struct, int value)` Unsafe version of `mipLevel`.
`VkImageSubresourceLayers`	`set(int aspectMask, int mipLevel, int baseArrayLayer, int layerCount)` Initializes this struct with the specified values.
`VkImageSubresourceLayers`	`set(VkImageSubresourceLayers src)` Copies the specified struct data to this struct.
`int`	`sizeof()`

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - ASPECTMASK
```
public static final int ASPECTMASK
```
    The struct member offsets.
  - MIPLEVEL
```
public static final int MIPLEVEL
```
    The struct member offsets.
  - BASEARRAYLAYER
```
public static final int BASEARRAYLAYER
```
    The struct member offsets.
  - LAYERCOUNT
```
public static final int LAYERCOUNT
```
    The struct member offsets.
- Constructor Detail
  - VkImageSubresourceLayers
```
public VkImageSubresourceLayers(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - aspectMask
```
public int aspectMask()
```
    Returns the value of the aspectMask field.
  - mipLevel
```
public int mipLevel()
```
    Returns the value of the mipLevel field.
  - baseArrayLayer
```
public int baseArrayLayer()
```
    Returns the value of the baseArrayLayer field.
  - layerCount
```
public int layerCount()
```
    Returns the value of the layerCount field.
  - aspectMask
```
public VkImageSubresourceLayers aspectMask(int value)
```
    Sets the specified value to the aspectMask field.
  - mipLevel
```
public VkImageSubresourceLayers mipLevel(int value)
```
    Sets the specified value to the mipLevel field.
  - baseArrayLayer
```
public VkImageSubresourceLayers baseArrayLayer(int value)
```
    Sets the specified value to the baseArrayLayer field.
  - layerCount
```
public VkImageSubresourceLayers layerCount(int value)
```
    Sets the specified value to the layerCount field.
  - set
```
public VkImageSubresourceLayers set(int aspectMask,
                                    int mipLevel,
                                    int baseArrayLayer,
                                    int layerCount)
```
    Initializes this struct with the specified values.
  - set
```
public VkImageSubresourceLayers set(VkImageSubresourceLayers src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkImageSubresourceLayers malloc()
```
    Returns a new VkImageSubresourceLayers instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkImageSubresourceLayers calloc()
```
    Returns a new VkImageSubresourceLayers instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkImageSubresourceLayers create()
```
    Returns a new VkImageSubresourceLayers instance allocated with BufferUtils.
  - create
```
public static VkImageSubresourceLayers create(long address)
```
    Returns a new VkImageSubresourceLayers instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkImageSubresourceLayers createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkImageSubresourceLayers.Buffer malloc(int capacity)
```
    Returns a new VkImageSubresourceLayers.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkImageSubresourceLayers.Buffer calloc(int capacity)
```
    Returns a new VkImageSubresourceLayers.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImageSubresourceLayers.Buffer create(int capacity)
```
    Returns a new VkImageSubresourceLayers.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImageSubresourceLayers.Buffer create(long address,
                                                     int capacity)
```
    Create a VkImageSubresourceLayers.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkImageSubresourceLayers.Buffer createSafe(long address,
                                                                   int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkImageSubresourceLayers mallocStack()
```
    Returns a new VkImageSubresourceLayers instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkImageSubresourceLayers callocStack()
```
    Returns a new VkImageSubresourceLayers instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkImageSubresourceLayers mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageSubresourceLayers instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkImageSubresourceLayers callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageSubresourceLayers instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkImageSubresourceLayers.Buffer mallocStack(int capacity)
```
    Returns a new VkImageSubresourceLayers.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImageSubresourceLayers.Buffer callocStack(int capacity)
```
    Returns a new VkImageSubresourceLayers.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkImageSubresourceLayers.Buffer mallocStack(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageSubresourceLayers.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImageSubresourceLayers.Buffer callocStack(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageSubresourceLayers.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - naspectMask
```
public static int naspectMask(long struct)
```
    Unsafe version of aspectMask().
  - nmipLevel
```
public static int nmipLevel(long struct)
```
    Unsafe version of mipLevel().
  - nbaseArrayLayer
```
public static int nbaseArrayLayer(long struct)
```
    Unsafe version of baseArrayLayer().
  - nlayerCount
```
public static int nlayerCount(long struct)
```
    Unsafe version of layerCount().
  - naspectMask
```
public static void naspectMask(long struct,
                               int value)
```
    Unsafe version of aspectMask.
  - nmipLevel
```
public static void nmipLevel(long struct,
                             int value)
```
    Unsafe version of mipLevel.
  - nbaseArrayLayer
```
public static void nbaseArrayLayer(long struct,
                                   int value)
```
    Unsafe version of baseArrayLayer.
  - nlayerCount
```
public static void nlayerCount(long struct,
                               int value)
```
    Unsafe version of layerCount.

Class VkImageSubresourceLayers

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

ASPECTMASK

MIPLEVEL

BASEARRAYLAYER

LAYERCOUNT

Constructor Detail

VkImageSubresourceLayers

Method Detail

sizeof

aspectMask

mipLevel

baseArrayLayer

layerCount

aspectMask

mipLevel

baseArrayLayer

layerCount

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

naspectMask

nmipLevel

nbaseArrayLayer

nlayerCount

naspectMask

nmipLevel

nbaseArrayLayer

nlayerCount