Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImageViewSlicedCreateInfoEXT

extends Struct<VkImageViewSlicedCreateInfoEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Specify the subset of 3D slices of an image view.
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
Valid Usage (Implicit)

Layout


struct VkImageViewSlicedCreateInfoEXT {
    VkStructureType sType;
    void const * pNext;
    uint32_t sliceOffset;
    uint32_t sliceCount;
}

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
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SLICECOUNT

The struct member offsets.

public static final int
SLICEOFFSET

The struct member offsets.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkImageViewSlicedCreateInfoEXT(long address, ByteBuffer container)

public
VkImageViewSlicedCreateInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkImageViewSlicedCreateInfoEXT
calloc()

Returns a new VkImageViewSlicedCreateInfoEXT instance allocated with memCalloc.

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

Returns a new VkImageViewSlicedCreateInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkImageViewSlicedCreateInfoEXT
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 VkImageViewSlicedCreateInfoEXT
create()

Returns a new VkImageViewSlicedCreateInfoEXT instance allocated with BufferUtils.

public static VkImageViewSlicedCreateInfoEXT
create(long address)

Returns a new VkImageViewSlicedCreateInfoEXT instance for the specified memory address.

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

Returns a new VkImageViewSlicedCreateInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkImageViewSlicedCreateInfoEXT.Buffer instance at the specified memory.

public static VkImageViewSlicedCreateInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkImageViewSlicedCreateInfoEXT
malloc()

Returns a new VkImageViewSlicedCreateInfoEXT instance allocated with memAlloc.

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

Returns a new VkImageViewSlicedCreateInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkImageViewSlicedCreateInfoEXT instance allocated on the specified MemoryStack.

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

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

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsliceCount(long struct)

Unsafe version of sliceCount.

public static void
nsliceCount(long struct, int value)

Unsafe version of sliceCount.

public static int
nsliceOffset(long struct)

Unsafe version of sliceOffset.

public static void
nsliceOffset(long struct, int value)

Unsafe version of sliceOffset.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkImageViewSlicedCreateInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkImageViewSlicedCreateInfoEXT
set(int sType, long pNext, int sliceOffset, int sliceCount)

Initializes this struct with the specified values.

public VkImageViewSlicedCreateInfoEXT

Returns:

this struct
set
(VkImageViewSlicedCreateInfoEXT
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).
public int
sliceCount()

the number of 3D slices accessible to the image view.

public VkImageViewSlicedCreateInfoEXT
sliceCount(int value)

Sets the specified value to the sliceCount field.

public int
sliceOffset()

the Z-offset for the first 3D slice accessible to the image view.

public VkImageViewSlicedCreateInfoEXT
sliceOffset(int value)

Sets the specified value to the sliceOffset field.

public int
sType()

a VkStructureType value identifying this structure.

public VkImageViewSlicedCreateInfoEXT
sType(int value)

Sets the specified value to the sType field.

public VkImageViewSlicedCreateInfoEXT
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.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SLICECOUNTback to summary
public static final int SLICECOUNT

The struct member offsets.

SLICEOFFSETback to summary
public static final int SLICEOFFSET

The struct member offsets.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkImageViewSlicedCreateInfoEXTback to summary
protected VkImageViewSlicedCreateInfoEXT(long address, ByteBuffer container)
VkImageViewSlicedCreateInfoEXTback to summary
public VkImageViewSlicedCreateInfoEXT(ByteBuffer container)

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

callocback to summary
public static VkImageViewSlicedCreateInfoEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImageViewSlicedCreateInfoEXT calloc(MemoryStack stack)

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

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

createback to summary
protected VkImageViewSlicedCreateInfoEXT 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 VkImageViewSlicedCreateInfoEXT create()

Returns a new VkImageViewSlicedCreateInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkImageViewSlicedCreateInfoEXT create(long address)

Returns a new VkImageViewSlicedCreateInfoEXT instance for the specified memory address.

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

Returns a new VkImageViewSlicedCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkImageViewSlicedCreateInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImageViewSlicedCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkImageViewSlicedCreateInfoEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImageViewSlicedCreateInfoEXT malloc(MemoryStack stack)

Returns a new VkImageViewSlicedCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsliceCountback to summary
public static int nsliceCount(long struct)

Unsafe version of sliceCount.

nsliceCountback to summary
public static void nsliceCount(long struct, int value)

Unsafe version of sliceCount.

nsliceOffsetback to summary
public static int nsliceOffset(long struct)

Unsafe version of sliceOffset.

nsliceOffsetback to summary
public static void nsliceOffset(long struct, int value)

Unsafe version of sliceOffset.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkImageViewSlicedCreateInfoEXT pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkImageViewSlicedCreateInfoEXT set(int sType, long pNext, int sliceOffset, int sliceCount)

Initializes this struct with the specified values.

setback to summary
public VkImageViewSlicedCreateInfoEXT set(VkImageViewSlicedCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkImageViewSlicedCreateInfoEXT

the source struct

Returns:VkImageViewSlicedCreateInfoEXT

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
sliceCountback to summary
public int sliceCount()

the number of 3D slices accessible to the image view.

Annotations
@NativeType:uint32_t
sliceCountback to summary
public VkImageViewSlicedCreateInfoEXT sliceCount(int value)

Sets the specified value to the sliceCount field.

sliceOffsetback to summary
public int sliceOffset()

the Z-offset for the first 3D slice accessible to the image view.

Annotations
@NativeType:uint32_t
sliceOffsetback to summary
public VkImageViewSlicedCreateInfoEXT sliceOffset(int value)

Sets the specified value to the sliceOffset field.

sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkImageViewSlicedCreateInfoEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkImageViewSlicedCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_VIEW_SLICED_CREATE_INFO_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkImageViewSlicedCreateInfoEXT.Buffer

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

An array of VkImageViewSlicedCreateInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkImageViewSlicedCreateInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkImageViewSlicedCreateInfoEXT.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
protected VkImageViewSlicedCreateInfoEXT
public long

Returns:

the value of the VkImageViewSlicedCreateInfoEXT#pNext field.
pNext
()

public VkImageViewSlicedCreateInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkImageViewSlicedCreateInfoEXT#pNext field.

protected VkImageViewSlicedCreateInfoEXT.Buffer
public int

Returns:

the value of the VkImageViewSlicedCreateInfoEXT#sliceCount field.
sliceCount
()

public VkImageViewSlicedCreateInfoEXT.Buffer
sliceCount(int value)

Sets the specified value to the VkImageViewSlicedCreateInfoEXT#sliceCount field.

public int

Returns:

the value of the VkImageViewSlicedCreateInfoEXT#sliceOffset field.
sliceOffset
()

public VkImageViewSlicedCreateInfoEXT.Buffer
sliceOffset(int value)

Sets the specified value to the VkImageViewSlicedCreateInfoEXT#sliceOffset field.

public int

Returns:

the value of the VkImageViewSlicedCreateInfoEXT#sType field.
sType
()

public VkImageViewSlicedCreateInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkImageViewSlicedCreateInfoEXT#sType field.

public VkImageViewSlicedCreateInfoEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImageViewSlicedCreateInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected VkImageViewSlicedCreateInfoEXT getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkImageViewSlicedCreateInfoEXT#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkImageViewSlicedCreateInfoEXT.Buffer pNext(long value)

Sets the specified value to the VkImageViewSlicedCreateInfoEXT#pNext field.

selfback to summary
protected VkImageViewSlicedCreateInfoEXT.Buffer self()

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

Annotations
@Override
sliceCountback to summary
public int sliceCount()
Returns:int

the value of the VkImageViewSlicedCreateInfoEXT#sliceCount field.

Annotations
@NativeType:uint32_t
sliceCountback to summary
public VkImageViewSlicedCreateInfoEXT.Buffer sliceCount(int value)

Sets the specified value to the VkImageViewSlicedCreateInfoEXT#sliceCount field.

sliceOffsetback to summary
public int sliceOffset()
Returns:int

the value of the VkImageViewSlicedCreateInfoEXT#sliceOffset field.

Annotations
@NativeType:uint32_t
sliceOffsetback to summary
public VkImageViewSlicedCreateInfoEXT.Buffer sliceOffset(int value)

Sets the specified value to the VkImageViewSlicedCreateInfoEXT#sliceOffset field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkImageViewSlicedCreateInfoEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkImageViewSlicedCreateInfoEXT.Buffer sType(int value)

Sets the specified value to the VkImageViewSlicedCreateInfoEXT#sType field.

sType$Defaultback to summary
public VkImageViewSlicedCreateInfoEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_VIEW_SLICED_CREATE_INFO_EXT value to the VkImageViewSlicedCreateInfoEXT#sType field.