Structure specifying an image subresource range.

Description

The number of mipmap levels and array layers must be a subset of the image subresources in the image. If an application wants to use all mip levels or layers in an image after the baseMipLevel or baseArrayLayer, it can set levelCount and layerCount to the special values REMAINING_MIP_LEVELS and REMAINING_ARRAY_LAYERS without knowing the exact number of mip levels or layers.

For cube and cube array image views, the layers of the image view starting at baseArrayLayer correspond to faces in the order +X, -X, +Y, -Y, +Z, -Z. For cube arrays, each set of six sequential layers is a single cube, so the number of cube maps in a cube map array view is layerCount / 6, and image array layer (baseArrayLayer + i) is face index (i mod 6) of cube i / 6. If the number of layers in the view, whether set explicitly in layerCount or implied by REMAINING_ARRAY_LAYERS, is not a multiple of 6, the last cube map in the array must not be accessed.

aspectMask must be only IMAGE_ASPECT_COLOR_BIT, IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT if format is a color, depth-only or stencil-only format, respectively, except if format is a multi-planar format. If using a depth/stencil format with both depth and stencil components, aspectMask must include at least one of IMAGE_ASPECT_DEPTH_BIT and IMAGE_ASPECT_STENCIL_BIT, and can include both.

When the VkImageSubresourceRange structure is used to select a subset of the slices of a 3D image’s mip level in order to create a 2D or 2D array image view of a 3D image created with IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT, baseArrayLayer and layerCount specify the first slice index and the number of slices to include in the created image view. Such an image view can be used as a framebuffer attachment that refers only to the specified range of slices of the selected mip level. However, any layout transitions performed on such an attachment view during a render pass instance still apply to the entire subresource referenced which includes all the slices of the selected mip level.

When using an image view of a depth/stencil image to populate a descriptor set (e.g. for sampling in the shader, or for use as an input attachment), the aspectMask must only include one bit, which selects whether the image view is used for depth reads (i.e. using a floating-point sampler or input attachment in the shader) or stencil reads (i.e. using an unsigned integer sampler or input attachment in the shader). When an image view of a depth/stencil image is used as a depth/stencil framebuffer attachment, the aspectMask is ignored and both depth and stencil image subresources are used.

When creating a VkImageView, if sampler Y′C_BC_R conversion is enabled in the sampler, the aspectMask of a subresourceRange used by the VkImageView must be IMAGE_ASPECT_COLOR_BIT.

When creating a VkImageView, if sampler Y′C_BC_R conversion is not enabled in the sampler and the image format is multi-planar, the image must have been created with IMAGE_CREATE_MUTABLE_FORMAT_BIT, and the aspectMask of the VkImageView’s subresourceRange must be IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT or IMAGE_ASPECT_PLANE_2_BIT.

Valid Usage

If levelCount is not REMAINING_MIP_LEVELS, it must be greater than 0
If layerCount is not REMAINING_ARRAY_LAYERS, it must be greater than 0
If aspectMask includes IMAGE_ASPECT_COLOR_BIT, then it must not include any of IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or IMAGE_ASPECT_PLANE_2_BIT
aspectMask must not include VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT for any index i

Valid Usage (Implicit)

aspectMask must be a valid combination of VkImageAspectFlagBits values
aspectMask must not be 0

Layout


struct VkImageSubresourceRange {
    VkImageAspectFlags aspectMask;
    uint32_t baseMipLevel;
    uint32_t levelCount;
    uint32_t baseArrayLayer;
    uint32_t layerCount;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	VkImageSubresourceRange.Buffer An array of `VkImageSubresourceRange` structs.

Field Summary

Modifier and Type	Field 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	BASEMIPLEVEL The struct member offsets.
public static final int	LAYERCOUNT The struct member offsets.
public static final int	LEVELCOUNT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkImageSubresourceRange(long address, ByteBuffer container)
public	VkImageSubresourceRange(ByteBuffer container) Creates a `VkImageSubresourceRange` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public int	aspectMask() a bitmask of `VkImageAspectFlagBits` specifying which aspect(s) of the image are included in the view.
public VkImageSubresourceRange	aspectMask(int value) Sets the specified value to the `aspectMask` field.
public int	baseArrayLayer() the first array layer accessible to the view.
public VkImageSubresourceRange	baseArrayLayer(int value) Sets the specified value to the `baseArrayLayer` field.
public int	baseMipLevel() the first mipmap level accessible to the view.
public VkImageSubresourceRange	baseMipLevel(int value) Sets the specified value to the `baseMipLevel` field.
public static VkImageSubresourceRange	calloc() Returns a new `VkImageSubresourceRange` instance allocated with `memCalloc`.
public static VkImageSubresourceRange.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkImageSubresourceRange.Buffer` instance allocated with `memCalloc`.
public static VkImageSubresourceRange	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkImageSubresourceRange` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkImageSubresourceRange.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkImageSubresourceRange.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkImageSubresourceRange	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkImageSubresourceRange	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkImageSubresourceRange.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkImageSubresourceRange.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkImageSubresourceRange	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 VkImageSubresourceRange	create() Returns a new `VkImageSubresourceRange` instance allocated with `BufferUtils`.
public static VkImageSubresourceRange	create(long address) Returns a new `VkImageSubresourceRange` instance for the specified memory address.
public static VkImageSubresourceRange.Buffer	create(int the buffer capacity capacity) Returns a new `VkImageSubresourceRange.Buffer` instance allocated with `BufferUtils`.
public static VkImageSubresourceRange.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkImageSubresourceRange.Buffer` instance at the specified memory.
public static VkImageSubresourceRange	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkImageSubresourceRange.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	layerCount() the number of array layers (starting from `baseArrayLayer`) accessible to the view.
public VkImageSubresourceRange	layerCount(int value) Sets the specified value to the `layerCount` field.
public int	levelCount() the number of mipmap levels (starting from `baseMipLevel`) accessible to the view.
public VkImageSubresourceRange	levelCount(int value) Sets the specified value to the `levelCount` field.
public static VkImageSubresourceRange	malloc() Returns a new `VkImageSubresourceRange` instance allocated with `memAlloc`.
public static VkImageSubresourceRange.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkImageSubresourceRange.Buffer` instance allocated with `memAlloc`.
public static VkImageSubresourceRange	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkImageSubresourceRange` instance allocated on the specified `MemoryStack`.
public static VkImageSubresourceRange.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkImageSubresourceRange.Buffer` instance allocated on the specified `MemoryStack`.
public static VkImageSubresourceRange	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkImageSubresourceRange	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkImageSubresourceRange.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkImageSubresourceRange.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
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	nbaseMipLevel(long struct) Unsafe version of `baseMipLevel`.
public static void	nbaseMipLevel(long struct, int value) Unsafe version of `baseMipLevel`.
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	nlevelCount(long struct) Unsafe version of `levelCount`.
public static void	nlevelCount(long struct, int value) Unsafe version of `levelCount`.
public VkImageSubresourceRange	set(int aspectMask, int baseMipLevel, int levelCount, int baseArrayLayer, int layerCount) Initializes this struct with the specified values.
public VkImageSubresourceRange	Returns: this struct set(VkImageSubresourceRange 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)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

ASPECTMASK	back to summary
public static final int ASPECTMASK The struct member offsets.

BASEARRAYLAYER	back to summary
public static final int BASEARRAYLAYER The struct member offsets.

BASEMIPLEVEL	back to summary
public static final int BASEMIPLEVEL The struct member offsets.

LAYERCOUNT	back to summary
public static final int LAYERCOUNT The struct member offsets.

LEVELCOUNT	back to summary
public static final int LEVELCOUNT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

VkImageSubresourceRange	back to summary
protected VkImageSubresourceRange(long address, ByteBuffer container)

VkImageSubresourceRange back to summary

VkImageSubresourceRange	back to summary
public VkImageSubresourceRange(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.

public VkImageSubresourceRange(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

aspectMask back to summary

aspectMask	back to summary
public int aspectMask() a bitmask of `VkImageAspectFlagBits` specifying which aspect(s) of the image are included in the view. Annotations @NativeType:VkImageAspectFlags

public int aspectMask()

a bitmask of VkImageAspectFlagBits specifying which aspect(s) of the image are included in the view.

Annotations

@NativeType:VkImageAspectFlags

aspectMask	back to summary
public VkImageSubresourceRange aspectMask(int value) Sets the specified value to the `aspectMask` field.

baseArrayLayer	back to summary
public int baseArrayLayer() the first array layer accessible to the view. Annotations @NativeType:uint32_t

baseArrayLayer

back to summary

public int baseArrayLayer()

the first array layer accessible to the view.

Annotations

@NativeType:uint32_t

baseArrayLayer	back to summary
public VkImageSubresourceRange baseArrayLayer(int value) Sets the specified value to the `baseArrayLayer` field.

baseMipLevel	back to summary
public int baseMipLevel() the first mipmap level accessible to the view. Annotations @NativeType:uint32_t

baseMipLevel

back to summary

public int baseMipLevel()

the first mipmap level accessible to the view.

Annotations

@NativeType:uint32_t

baseMipLevel	back to summary
public VkImageSubresourceRange baseMipLevel(int value) Sets the specified value to the `baseMipLevel` field.

calloc	back to summary
public static VkImageSubresourceRange calloc() Returns a new `VkImageSubresourceRange` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkImageSubresourceRange.Buffer calloc(int capacity) Returns a new `VkImageSubresourceRange.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkImageSubresourceRange.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkImageSubresourceRange calloc(MemoryStack stack) Returns a new `VkImageSubresourceRange` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkImageSubresourceRange calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkImageSubresourceRange.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkImageSubresourceRange.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

public static VkImageSubresourceRange.Buffer calloc(int capacity, MemoryStack stack)

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

callocStack back to summary

callocStack	back to summary
public static VkImageSubresourceRange callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkImageSubresourceRange callocStack()

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkImageSubresourceRange callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkImageSubresourceRange callocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkImageSubresourceRange.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkImageSubresourceRange.Buffer callocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkImageSubresourceRange.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkImageSubresourceRange.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

create back to summary

create	back to summary
protected VkImageSubresourceRange 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

protected VkImageSubresourceRange 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

create	back to summary
public static VkImageSubresourceRange create() Returns a new `VkImageSubresourceRange` instance allocated with `BufferUtils`.

create	back to summary
public static VkImageSubresourceRange create(long address) Returns a new `VkImageSubresourceRange` instance for the specified memory address.

create back to summary

create	back to summary
public static VkImageSubresourceRange.Buffer create(int capacity) Returns a new `VkImageSubresourceRange.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkImageSubresourceRange.Buffer create(int capacity)

Returns a new VkImageSubresourceRange.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkImageSubresourceRange.Buffer create(long address, int capacity) Create a `VkImageSubresourceRange.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static VkImageSubresourceRange.Buffer create(long address, int capacity)

Create a VkImageSubresourceRange.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkImageSubresourceRange createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkImageSubresourceRange createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkImageSubresourceRange.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

layerCount back to summary

layerCount	back to summary
public int layerCount() the number of array layers (starting from `baseArrayLayer`) accessible to the view. Annotations @NativeType:uint32_t

public int layerCount()

the number of array layers (starting from baseArrayLayer) accessible to the view.

Annotations

@NativeType:uint32_t

layerCount	back to summary
public VkImageSubresourceRange layerCount(int value) Sets the specified value to the `layerCount` field.

levelCount back to summary

levelCount	back to summary
public int levelCount() the number of mipmap levels (starting from `baseMipLevel`) accessible to the view. Annotations @NativeType:uint32_t

public int levelCount()

the number of mipmap levels (starting from baseMipLevel) accessible to the view.

Annotations

@NativeType:uint32_t

levelCount	back to summary
public VkImageSubresourceRange levelCount(int value) Sets the specified value to the `levelCount` field.

malloc	back to summary
public static VkImageSubresourceRange malloc() Returns a new `VkImageSubresourceRange` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkImageSubresourceRange.Buffer malloc(int capacity) Returns a new `VkImageSubresourceRange.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkImageSubresourceRange.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkImageSubresourceRange malloc(MemoryStack stack) Returns a new `VkImageSubresourceRange` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkImageSubresourceRange malloc(MemoryStack stack)

Returns a new VkImageSubresourceRange instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkImageSubresourceRange.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkImageSubresourceRange.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkImageSubresourceRange.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

mallocStack	back to summary
public static VkImageSubresourceRange mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkImageSubresourceRange mallocStack()

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkImageSubresourceRange mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkImageSubresourceRange mallocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkImageSubresourceRange.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkImageSubresourceRange.Buffer mallocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkImageSubresourceRange.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkImageSubresourceRange.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

naspectMask	back to summary
public static int naspectMask(long struct) Unsafe version of `aspectMask`.

naspectMask	back to summary
public static void naspectMask(long struct, int value) Unsafe version of `aspectMask`.

nbaseArrayLayer	back to summary
public static int nbaseArrayLayer(long struct) Unsafe version of `baseArrayLayer`.

nbaseArrayLayer	back to summary
public static void nbaseArrayLayer(long struct, int value) Unsafe version of `baseArrayLayer`.

nbaseMipLevel	back to summary
public static int nbaseMipLevel(long struct) Unsafe version of `baseMipLevel`.

nbaseMipLevel	back to summary
public static void nbaseMipLevel(long struct, int value) Unsafe version of `baseMipLevel`.

nlayerCount	back to summary
public static int nlayerCount(long struct) Unsafe version of `layerCount`.

nlayerCount	back to summary
public static void nlayerCount(long struct, int value) Unsafe version of `layerCount`.

nlevelCount	back to summary
public static int nlevelCount(long struct) Unsafe version of `levelCount`.

nlevelCount	back to summary
public static void nlevelCount(long struct, int value) Unsafe version of `levelCount`.

set	back to summary
public VkImageSubresourceRange set(int aspectMask, int baseMipLevel, int levelCount, int baseArrayLayer, int layerCount) Initializes this struct with the specified values.

set

back to summary

public VkImageSubresourceRange set(VkImageSubresourceRange src)

Copies the specified struct data to this struct.

Parameters

src:VkImageSubresourceRange: the source struct

Returns:VkImageSubresourceRange

this struct

sizeof back 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 VkImageSubresourceRange.Buffer

Class Inheritance

extends StructBuffer<VkImageSubresourceRange, VkImageSubresourceRange.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkImageSubresourceRange.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkImageSubresourceRange structs.

Field Summary

Modifier and Type	Field and Description
private static final VkImageSubresourceRange	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkImageSubresourceRange.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 Type	Method and Description
public int	Returns: the value of the `VkImageSubresourceRange#aspectMask` field. aspectMask()
public VkImageSubresourceRange.Buffer	aspectMask(int value) Sets the specified value to the `VkImageSubresourceRange#aspectMask` field.
public int	Returns: the value of the `VkImageSubresourceRange#baseArrayLayer` field. baseArrayLayer()
public VkImageSubresourceRange.Buffer	baseArrayLayer(int value) Sets the specified value to the `VkImageSubresourceRange#baseArrayLayer` field.
public int	Returns: the value of the `VkImageSubresourceRange#baseMipLevel` field. baseMipLevel()
public VkImageSubresourceRange.Buffer	baseMipLevel(int value) Sets the specified value to the `VkImageSubresourceRange#baseMipLevel` field.
protected VkImageSubresourceRange	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `VkImageSubresourceRange#layerCount` field. layerCount()
public VkImageSubresourceRange.Buffer	layerCount(int value) Sets the specified value to the `VkImageSubresourceRange#layerCount` field.
public int	Returns: the value of the `VkImageSubresourceRange#levelCount` field. levelCount()
public VkImageSubresourceRange.Buffer	levelCount(int value) Sets the specified value to the `VkImageSubresourceRange#levelCount` field.
protected VkImageSubresourceRange.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkImageSubresourceRange ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkImageSubresourceRange.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 VkImageSubresourceRange#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

aspectMask	back to summary
public int aspectMask() Returns:int the value of the `VkImageSubresourceRange#aspectMask` field. Annotations @NativeType:VkImageAspectFlags

aspectMask	back to summary
public VkImageSubresourceRange.Buffer aspectMask(int value) Sets the specified value to the `VkImageSubresourceRange#aspectMask` field.

baseArrayLayer	back to summary
public int baseArrayLayer() Returns:int the value of the `VkImageSubresourceRange#baseArrayLayer` field. Annotations @NativeType:uint32_t

baseArrayLayer	back to summary
public VkImageSubresourceRange.Buffer baseArrayLayer(int value) Sets the specified value to the `VkImageSubresourceRange#baseArrayLayer` field.

baseMipLevel	back to summary
public int baseMipLevel() Returns:int the value of the `VkImageSubresourceRange#baseMipLevel` field. Annotations @NativeType:uint32_t

baseMipLevel	back to summary
public VkImageSubresourceRange.Buffer baseMipLevel(int value) Sets the specified value to the `VkImageSubresourceRange#baseMipLevel` field.

getElementFactory

back to summary

protected VkImageSubresourceRange getElementFactory()

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

Annotations

@Override

layerCount	back to summary
public int layerCount() Returns:int the value of the `VkImageSubresourceRange#layerCount` field. Annotations @NativeType:uint32_t

layerCount	back to summary
public VkImageSubresourceRange.Buffer layerCount(int value) Sets the specified value to the `VkImageSubresourceRange#layerCount` field.

levelCount	back to summary
public int levelCount() Returns:int the value of the `VkImageSubresourceRange#levelCount` field. Annotations @NativeType:uint32_t

levelCount	back to summary
public VkImageSubresourceRange.Buffer levelCount(int value) Sets the specified value to the `VkImageSubresourceRange#levelCount` field.

self

back to summary

protected VkImageSubresourceRange.Buffer self()

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

Annotations

@Override

public Class VkImageSubresourceRange

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkImageSubresourceRange.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail