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

All Implemented Interfaces:

java.lang.AutoCloseable, NativeResource, Pointer
```
public class VkImageSubresourceRange
extends Struct
```
Khronos Reference Page
Vulkan Specification
Describes a range of mipmap levels, array layers, and aspects.

Valid Usage
- aspectMask must be a valid combination of VkImageAspectFlagBits values
- aspectMask must not be 0
- If levelCount is not REMAINING_MIP_LEVELS, baseMipLevel + levelCount must be less than or equal to the mipLevels specified in VkImageCreateInfo when the image was created
- If layerCount is not REMAINING_ARRAY_LAYERS, baseArrayLayer + layerCount must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the image was created
Member documentation
- aspectMask – a bitmask indicating which aspect(s) of the image are included in the view. One or more of:
  IMAGE_ASPECT_COLOR_BIT IMAGE_ASPECT_DEPTH_BIT IMAGE_ASPECT_METADATA_BIT
  IMAGE_ASPECT_STENCIL_BIT
- baseMipLevel – the first mipmap level accessible to the view
- levelCount – the number of mipmap levels (starting from baseMipLevel) accessible to the view
- baseArrayLayer – the first array layer accessible to the view
- layerCount – the number of array layers (starting from baseArrayLayer) accessible to the view
Layout
```
struct VkImageSubresourceRange {
    VkImageAspectFlags aspectMask;
    uint32_t baseMipLevel;
    uint32_t levelCount;
    uint32_t baseArrayLayer;
    uint32_t layerCount;
}
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type Field and Description

static int SIZEOF
The struct size in bytes.
- Fields inherited from interface org.lwjgl.system.Pointer
  POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkImageSubresourceRange(java.nio.ByteBuffer container)` Creates a `VkImageSubresourceRange` 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.
`VkImageSubresourceRange`	`aspectMask(int value)` Sets the specified value to the `aspectMask` field.
`int`	`baseArrayLayer()` Returns the value of the `baseArrayLayer` field.
`VkImageSubresourceRange`	`baseArrayLayer(int value)` Sets the specified value to the `baseArrayLayer` field.
`int`	`baseMipLevel()` Returns the value of the `baseMipLevel` field.
`VkImageSubresourceRange`	`baseMipLevel(int value)` Sets the specified value to the `baseMipLevel` field.
`static VkImageSubresourceRange`	`calloc()` Returns a new `VkImageSubresourceRange` instance allocated with `memCalloc`.
`static VkImageSubresourceRange.Buffer`	`calloc(int capacity)` Returns a new `VkImageSubresourceRange.Buffer` instance allocated with `memCalloc`.
`static VkImageSubresourceRange`	`callocStack()` Returns a new `VkImageSubresourceRange` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageSubresourceRange.Buffer`	`callocStack(int capacity)` Returns a new `VkImageSubresourceRange.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageSubresourceRange.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkImageSubresourceRange.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageSubresourceRange`	`callocStack(MemoryStack stack)` Returns a new `VkImageSubresourceRange` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageSubresourceRange`	`create()` Returns a new `VkImageSubresourceRange` instance allocated with `BufferUtils`.
`static VkImageSubresourceRange.Buffer`	`create(int capacity)` Returns a new `VkImageSubresourceRange.Buffer` instance allocated with `BufferUtils`.
`static VkImageSubresourceRange`	`create(long address)` Returns a new `VkImageSubresourceRange` instance for the specified memory address or `null` if the address is `NULL`.
`static VkImageSubresourceRange.Buffer`	`create(long address, int capacity)` Create a `VkImageSubresourceRange.Buffer` instance at the specified memory.
`int`	`layerCount()` Returns the value of the `layerCount` field.
`VkImageSubresourceRange`	`layerCount(int value)` Sets the specified value to the `layerCount` field.
`int`	`levelCount()` Returns the value of the `levelCount` field.
`VkImageSubresourceRange`	`levelCount(int value)` Sets the specified value to the `levelCount` field.
`static VkImageSubresourceRange`	`malloc()` Returns a new `VkImageSubresourceRange` instance allocated with `memAlloc`.
`static VkImageSubresourceRange.Buffer`	`malloc(int capacity)` Returns a new `VkImageSubresourceRange.Buffer` instance allocated with `memAlloc`.
`static VkImageSubresourceRange`	`mallocStack()` Returns a new `VkImageSubresourceRange` instance allocated on the thread-local `MemoryStack`.
`static VkImageSubresourceRange.Buffer`	`mallocStack(int capacity)` Returns a new `VkImageSubresourceRange.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkImageSubresourceRange.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkImageSubresourceRange.Buffer` instance allocated on the specified `MemoryStack`.
`static VkImageSubresourceRange`	`mallocStack(MemoryStack stack)` Returns a new `VkImageSubresourceRange` instance allocated on the specified `MemoryStack`.
`VkImageSubresourceRange`	`nset(long struct)` Unsafe version of `set`.
`VkImageSubresourceRange`	`set(int aspectMask, int baseMipLevel, int levelCount, int baseArrayLayer, int layerCount)` Initializes this struct with the specified values.
`VkImageSubresourceRange`	`set(VkImageSubresourceRange src)` Copies the specified struct data to this struct.
`int`	`sizeof()` Returns the `sizeof(struct)`.

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- Constructor Detail
  - VkImageSubresourceRange
```
public VkImageSubresourceRange(java.nio.ByteBuffer container)
```
    Creates a VkImageSubresourceRange 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()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class Struct
  - aspectMask
```
public int aspectMask()
```
    Returns the value of the aspectMask field.
  - baseMipLevel
```
public int baseMipLevel()
```
    Returns the value of the baseMipLevel field.
  - levelCount
```
public int levelCount()
```
    Returns the value of the levelCount 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 VkImageSubresourceRange aspectMask(int value)
```
    Sets the specified value to the aspectMask field.
  - baseMipLevel
```
public VkImageSubresourceRange baseMipLevel(int value)
```
    Sets the specified value to the baseMipLevel field.
  - levelCount
```
public VkImageSubresourceRange levelCount(int value)
```
    Sets the specified value to the levelCount field.
  - baseArrayLayer
```
public VkImageSubresourceRange baseArrayLayer(int value)
```
    Sets the specified value to the baseArrayLayer field.
  - layerCount
```
public VkImageSubresourceRange layerCount(int value)
```
    Sets the specified value to the layerCount field.
  - set
```
public VkImageSubresourceRange set(int aspectMask,
                                   int baseMipLevel,
                                   int levelCount,
                                   int baseArrayLayer,
                                   int layerCount)
```
    Initializes this struct with the specified values.
  - nset
```
public VkImageSubresourceRange nset(long struct)
```
    Unsafe version of set.
  - set
```
public VkImageSubresourceRange set(VkImageSubresourceRange src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkImageSubresourceRange malloc()
```
    Returns a new VkImageSubresourceRange instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkImageSubresourceRange calloc()
```
    Returns a new VkImageSubresourceRange instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkImageSubresourceRange create()
```
    Returns a new VkImageSubresourceRange instance allocated with BufferUtils.
  - create
```
public static VkImageSubresourceRange create(long address)
```
    Returns a new VkImageSubresourceRange instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkImageSubresourceRange.Buffer malloc(int capacity)
```
    Returns a new VkImageSubresourceRange.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkImageSubresourceRange.Buffer calloc(int capacity)
```
    Returns a new VkImageSubresourceRange.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImageSubresourceRange.Buffer create(int capacity)
```
    Returns a new VkImageSubresourceRange.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImageSubresourceRange.Buffer create(long address,
                                                    int capacity)
```
    Create a VkImageSubresourceRange.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkImageSubresourceRange mallocStack()
```
    Returns a new VkImageSubresourceRange instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkImageSubresourceRange callocStack()
```
    Returns a new VkImageSubresourceRange instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkImageSubresourceRange mallocStack(MemoryStack stack)
```
    Returns a new VkImageSubresourceRange instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkImageSubresourceRange callocStack(MemoryStack stack)
```
    Returns a new VkImageSubresourceRange instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkImageSubresourceRange.Buffer mallocStack(int capacity)
```
    Returns a new VkImageSubresourceRange.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImageSubresourceRange.Buffer callocStack(int capacity)
```
    Returns a new VkImageSubresourceRange.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkImageSubresourceRange.Buffer mallocStack(int capacity,
                                                         MemoryStack stack)
```
    Returns a new VkImageSubresourceRange.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImageSubresourceRange.Buffer callocStack(int capacity,
                                                         MemoryStack stack)
```
    Returns a new VkImageSubresourceRange.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

`IMAGE_ASPECT_COLOR_BIT`	`IMAGE_ASPECT_DEPTH_BIT`	`IMAGE_ASPECT_METADATA_BIT`
`IMAGE_ASPECT_STENCIL_BIT`

Class VkImageSubresourceRange

Valid Usage

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

Constructor Detail

VkImageSubresourceRange

Method Detail

sizeof

aspectMask

baseMipLevel

levelCount

baseArrayLayer

layerCount

aspectMask

baseMipLevel

levelCount

baseArrayLayer

layerCount

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack