Class VkImageViewSlicedCreateInfoEXT
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
When this structure is chained to VkImageViewCreateInfo the sliceOffset field is treated as a Z-offset for the sliced view and sliceCount specifies the range. Shader accesses using a Z coordinate of 0 will access the depth slice corresponding to sliceOffset in the image, and in a shader, the maximum in-bounds Z coordinate for the view is sliceCount - 1.
A sliced 3D view must only be used with a single mip level. The slice coordinates are integer coordinates within the subresourceRange.baseMipLevel used to create the image view.
The effective view depth is equal to extent.depth used to create the image for this view adjusted by subresourceRange.baseMipLevel as specified in Image Mip Level Sizing.
Shader access to this image view is only affected by VkImageViewSlicedCreateInfoEXT if it uses a descriptor of type DESCRIPTOR_TYPE_STORAGE_IMAGE. For access using any other descriptor type, the contents of VkImageViewSlicedCreateInfoEXT are ignored; instead, sliceOffset is treated as being equal to 0, and sliceCount is treated as being equal to REMAINING_3D_SLICES_EXT.
Valid Usage
sliceOffsetmust be less than the effective view depth as specified in Image Mip Level Sizing- If
sliceCountis notREMAINING_3D_SLICES_EXT, it must be non-zero andsliceOffset + sliceCountmust be less than or equal to the effective view depth as specified in Image Mip Level Sizing imagemust have been created withimageTypeequal toIMAGE_TYPE_3DviewTypemust beIMAGE_VIEW_TYPE_3D- The image view must reference exactly 1 mip level
- The imageSlicedViewOf3D feature must be enabled
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_IMAGE_VIEW_SLICED_CREATE_INFO_EXT
Layout
struct VkImageViewSlicedCreateInfoEXT {
VkStructureType sType();
void const * pNext();
uint32_t sliceOffset();
uint32_t sliceCount();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkImageViewSlicedCreateInfoEXTstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkImageViewSlicedCreateInfoEXT(ByteBuffer container) Creates aVkImageViewSlicedCreateInfoEXTinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkImageViewSlicedCreateInfoEXTinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkImageViewSlicedCreateInfoEXT.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageViewSlicedCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImageViewSlicedCreateInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkImageViewSlicedCreateInfoEXTinstance allocated withBufferUtils.create(int capacity) Returns a newVkImageViewSlicedCreateInfoEXT.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkImageViewSlicedCreateInfoEXTinstance for the specified memory address.create(long address, int capacity) Create aVkImageViewSlicedCreateInfoEXT.Bufferinstance at the specified memory.static @Nullable VkImageViewSlicedCreateInfoEXTcreateSafe(long address) static @Nullable VkImageViewSlicedCreateInfoEXT.BuffercreateSafe(long address, int capacity) malloc()Returns a newVkImageViewSlicedCreateInfoEXTinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkImageViewSlicedCreateInfoEXT.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageViewSlicedCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImageViewSlicedCreateInfoEXTinstance allocated on the specifiedMemoryStack.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsliceCount(long struct) Unsafe version ofsliceCount().static voidnsliceCount(long struct, int value) Unsafe version ofsliceCount.static intnsliceOffset(long struct) Unsafe version ofsliceOffset().static voidnsliceOffset(long struct, int value) Unsafe version ofsliceOffset.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.set(int sType, long pNext, int sliceOffset, int sliceCount) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intthe number of 3D slices accessible to the image view.sliceCount(int value) Sets the specified value to thesliceCount()field.intthe Z-offset for the first 3D slice accessible to the image view.sliceOffset(int value) Sets the specified value to thesliceOffset()field.intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_IMAGE_VIEW_SLICED_CREATE_INFO_EXTvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
SLICEOFFSET
public static final int SLICEOFFSETThe struct member offsets. -
SLICECOUNT
public static final int SLICECOUNTThe struct member offsets.
-
-
Constructor Details
-
VkImageViewSlicedCreateInfoEXT
Creates aVkImageViewSlicedCreateInfoEXTinstance at the current position of the specifiedByteBuffercontainer. 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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkImageViewSlicedCreateInfoEXT>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
sliceOffset
public int sliceOffset()the Z-offset for the first 3D slice accessible to the image view. -
sliceCount
public int sliceCount()the number of 3D slices accessible to the image view. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_IMAGE_VIEW_SLICED_CREATE_INFO_EXTvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
sliceOffset
Sets the specified value to thesliceOffset()field. -
sliceCount
Sets the specified value to thesliceCount()field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkImageViewSlicedCreateInfoEXTinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkImageViewSlicedCreateInfoEXTinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkImageViewSlicedCreateInfoEXTinstance allocated withBufferUtils. -
create
Returns a newVkImageViewSlicedCreateInfoEXTinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkImageViewSlicedCreateInfoEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkImageViewSlicedCreateInfoEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkImageViewSlicedCreateInfoEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkImageViewSlicedCreateInfoEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkImageViewSlicedCreateInfoEXT.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkImageViewSlicedCreateInfoEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkImageViewSlicedCreateInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkImageViewSlicedCreateInfoEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageViewSlicedCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkImageViewSlicedCreateInfoEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageViewSlicedCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nsliceOffset
public static int nsliceOffset(long struct) Unsafe version ofsliceOffset(). -
nsliceCount
public static int nsliceCount(long struct) Unsafe version ofsliceCount(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nsliceOffset
public static void nsliceOffset(long struct, int value) Unsafe version ofsliceOffset. -
nsliceCount
public static void nsliceCount(long struct, int value) Unsafe version ofsliceCount.
-