Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkExtent3D

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

Structure specifying a three-dimensional extent.
See Also

VkBufferImageCopy, VkBufferImageCopy2, VkCopyMemoryToImageIndirectCommandNV, VkImageCopy, VkImageCopy2, VkImageCreateInfo, VkImageFormatProperties, VkImageResolve, VkImageResolve2, VkImageToMemoryCopyEXT, VkMemoryToImageCopyEXT, VkQueueFamilyProperties, VkSparseImageFormatProperties, VkSparseImageMemoryBind, VkTilePropertiesQCOM

Layout


struct VkExtent3D {
    uint32_t width;
    uint32_t height;
    uint32_t depth;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkExtent3D.Buffer

An array of VkExtent3D structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DEPTH

The struct member offsets.

public static final int
HEIGHT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
WIDTH

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkExtent3D(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkExtent3D
calloc()

Returns a new VkExtent3D instance allocated with memCalloc.

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

Returns a new VkExtent3D.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkExtent3D
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkExtent3D
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkExtent3D.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkExtent3D.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkExtent3D
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 VkExtent3D
create()

Returns a new VkExtent3D instance allocated with BufferUtils.

public static VkExtent3D
create(long address)

Returns a new VkExtent3D instance for the specified memory address.

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

Returns a new VkExtent3D.Buffer instance allocated with BufferUtils.

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

Create a VkExtent3D.Buffer instance at the specified memory.

public static VkExtent3D
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
depth()

the depth of the extent.

public VkExtent3D
depth(int value)

Sets the specified value to the depth field.

public int
height()

the height of the extent.

public VkExtent3D
height(int value)

Sets the specified value to the height field.

public static VkExtent3D
malloc()

Returns a new VkExtent3D instance allocated with memAlloc.

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

Returns a new VkExtent3D.Buffer instance allocated with memAlloc.

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

Returns a new VkExtent3D instance allocated on the specified MemoryStack.

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

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

public static VkExtent3D
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkExtent3D
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkExtent3D.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkExtent3D.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
ndepth(long struct)

Unsafe version of depth.

public static void
ndepth(long struct, int value)

Unsafe version of depth.

public static int
nheight(long struct)

Unsafe version of height.

public static void
nheight(long struct, int value)

Unsafe version of height.

public static int
nwidth(long struct)

Unsafe version of width.

public static void
nwidth(long struct, int value)

Unsafe version of width.

public VkExtent3D
set(int width, int height, int depth)

Initializes this struct with the specified values.

public VkExtent3D

Returns:

this struct
set
(VkExtent3D
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
width()

the width of the extent.

public VkExtent3D
width(int value)

Sets the specified value to the width field.

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.

DEPTHback to summary
public static final int DEPTH

The struct member offsets.

HEIGHTback to summary
public static final int HEIGHT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

WIDTHback to summary
public static final int WIDTH

The struct member offsets.

Constructor Detail

VkExtent3Dback to summary
protected VkExtent3D(long address, ByteBuffer container)
VkExtent3Dback to summary
public VkExtent3D(ByteBuffer container)

Creates a VkExtent3D 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 VkExtent3D calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkExtent3D calloc(MemoryStack stack)

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

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

callocStackback to summary
public static VkExtent3D callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkExtent3D callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkExtent3D.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkExtent3D.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkExtent3D 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 VkExtent3D create()

Returns a new VkExtent3D instance allocated with BufferUtils.

createback to summary
public static VkExtent3D create(long address)

Returns a new VkExtent3D instance for the specified memory address.

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

Returns a new VkExtent3D.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkExtent3D.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkExtent3D createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
depthback to summary
public int depth()

the depth of the extent.

Annotations
@NativeType:uint32_t
depthback to summary
public VkExtent3D depth(int value)

Sets the specified value to the depth field.

heightback to summary
public int height()

the height of the extent.

Annotations
@NativeType:uint32_t
heightback to summary
public VkExtent3D height(int value)

Sets the specified value to the height field.

mallocback to summary
public static VkExtent3D malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkExtent3D malloc(MemoryStack stack)

Returns a new VkExtent3D instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkExtent3D mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkExtent3D mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkExtent3D.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkExtent3D.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
ndepthback to summary
public static int ndepth(long struct)

Unsafe version of depth.

ndepthback to summary
public static void ndepth(long struct, int value)

Unsafe version of depth.

nheightback to summary
public static int nheight(long struct)

Unsafe version of height.

nheightback to summary
public static void nheight(long struct, int value)

Unsafe version of height.

nwidthback to summary
public static int nwidth(long struct)

Unsafe version of width.

nwidthback to summary
public static void nwidth(long struct, int value)

Unsafe version of width.

setback to summary
public VkExtent3D set(int width, int height, int depth)

Initializes this struct with the specified values.

setback to summary
public VkExtent3D set(VkExtent3D src)

Copies the specified struct data to this struct.

Parameters
src:VkExtent3D

the source struct

Returns:VkExtent3D

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
widthback to summary
public int width()

the width of the extent.

Annotations
@NativeType:uint32_t
widthback to summary
public VkExtent3D width(int value)

Sets the specified value to the width field.

org.lwjgl.vulkan back to summary

public Class VkExtent3D.Buffer

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

An array of VkExtent3D structs.

Field Summary

Modifier and TypeField and Description
private static final VkExtent3D

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkExtent3D.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
public int

Returns:

the value of the VkExtent3D#depth field.
depth
()

public VkExtent3D.Buffer
depth(int value)

Sets the specified value to the VkExtent3D#depth field.

protected VkExtent3D
public int

Returns:

the value of the VkExtent3D#height field.
height
()

public VkExtent3D.Buffer
height(int value)

Sets the specified value to the VkExtent3D#height field.

protected VkExtent3D.Buffer
public int

Returns:

the value of the VkExtent3D#width field.
width
()

public VkExtent3D.Buffer
width(int value)

Sets the specified value to the VkExtent3D#width field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkExtent3D ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

depthback to summary
public int depth()
Returns:int

the value of the VkExtent3D#depth field.

Annotations
@NativeType:uint32_t
depthback to summary
public VkExtent3D.Buffer depth(int value)

Sets the specified value to the VkExtent3D#depth field.

getElementFactoryback to summary
protected VkExtent3D getElementFactory()

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

Annotations
@Override
heightback to summary
public int height()
Returns:int

the value of the VkExtent3D#height field.

Annotations
@NativeType:uint32_t
heightback to summary
public VkExtent3D.Buffer height(int value)

Sets the specified value to the VkExtent3D#height field.

selfback to summary
protected VkExtent3D.Buffer self()

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

Annotations
@Override
widthback to summary
public int width()
Returns:int

the value of the VkExtent3D#width field.

Annotations
@NativeType:uint32_t
widthback to summary
public VkExtent3D.Buffer width(int value)

Sets the specified value to the VkExtent3D#width field.