Package org.lwjgl.vulkan
Class VkExtent3D
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkExtent3D
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkExtent3D extends Struct
Khronos Reference Page
Vulkan SpecificationDescribes the size of a rectangular region of pixels within a three-dimensional image or framebuffer.
Member documentation
width– the region widthheight– the region heightdepth– the region depth
Layout
struct VkExtent3D { uint32_t width; uint32_t height; uint32_t depth; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkExtent3D.BufferAn array ofVkExtent3Dstructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkExtent3D(java.nio.ByteBuffer container)Creates aVkExtent3Dinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkExtent3Dcalloc()Returns a newVkExtent3Dinstance allocated withmemCalloc.static VkExtent3D.Buffercalloc(int capacity)Returns a newVkExtent3D.Bufferinstance allocated withmemCalloc.static VkExtent3DcallocStack()Returns a newVkExtent3Dinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkExtent3D.BuffercallocStack(int capacity)Returns a newVkExtent3D.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkExtent3D.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkExtent3D.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkExtent3DcallocStack(MemoryStack stack)Returns a newVkExtent3Dinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkExtent3Dcreate()Returns a newVkExtent3Dinstance allocated withBufferUtils.static VkExtent3D.Buffercreate(int capacity)Returns a newVkExtent3D.Bufferinstance allocated withBufferUtils.static VkExtent3Dcreate(long address)static VkExtent3D.Buffercreate(long address, int capacity)Create aVkExtent3D.Bufferinstance at the specified memory.intdepth()Returns the value of thedepthfield.VkExtent3Ddepth(int value)Sets the specified value to thedepthfield.intheight()Returns the value of theheightfield.VkExtent3Dheight(int value)Sets the specified value to theheightfield.static VkExtent3Dmalloc()Returns a newVkExtent3Dinstance allocated withmemAlloc.static VkExtent3D.Buffermalloc(int capacity)Returns a newVkExtent3D.Bufferinstance allocated withmemAlloc.static VkExtent3DmallocStack()Returns a newVkExtent3Dinstance allocated on the thread-localMemoryStack.static VkExtent3D.BuffermallocStack(int capacity)Returns a newVkExtent3D.Bufferinstance allocated on the thread-localMemoryStack.static VkExtent3D.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkExtent3D.Bufferinstance allocated on the specifiedMemoryStack.static VkExtent3DmallocStack(MemoryStack stack)Returns a newVkExtent3Dinstance allocated on the specifiedMemoryStack.VkExtent3Dnset(long struct)Unsafe version ofset.VkExtent3Dset(int width, int height, int depth)Initializes this struct with the specified values.VkExtent3Dset(VkExtent3D src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).intwidth()Returns the value of thewidthfield.VkExtent3Dwidth(int value)Sets the specified value to thewidthfield.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkExtent3D
public VkExtent3D(java.nio.ByteBuffer container)
Creates aVkExtent3Dinstance 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 Detail
-
sizeof
public int sizeof()
Description copied from class:StructReturns thesizeof(struct).
-
width
public int width()
Returns the value of thewidthfield.
-
height
public int height()
Returns the value of theheightfield.
-
depth
public int depth()
Returns the value of thedepthfield.
-
width
public VkExtent3D width(int value)
Sets the specified value to thewidthfield.
-
height
public VkExtent3D height(int value)
Sets the specified value to theheightfield.
-
depth
public VkExtent3D depth(int value)
Sets the specified value to thedepthfield.
-
set
public VkExtent3D set(int width, int height, int depth)
Initializes this struct with the specified values.
-
nset
public VkExtent3D nset(long struct)
Unsafe version ofset.
-
set
public VkExtent3D set(VkExtent3D src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkExtent3D malloc()
Returns a newVkExtent3Dinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkExtent3D calloc()
Returns a newVkExtent3Dinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkExtent3D create()
Returns a newVkExtent3Dinstance allocated withBufferUtils.
-
create
public static VkExtent3D create(long address)
-
malloc
public static VkExtent3D.Buffer malloc(int capacity)
Returns a newVkExtent3D.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkExtent3D.Buffer calloc(int capacity)
Returns a newVkExtent3D.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkExtent3D.Buffer create(int capacity)
Returns a newVkExtent3D.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkExtent3D.Buffer create(long address, int capacity)
Create aVkExtent3D.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkExtent3D mallocStack()
Returns a newVkExtent3Dinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkExtent3D callocStack()
Returns a newVkExtent3Dinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkExtent3D mallocStack(MemoryStack stack)
Returns a newVkExtent3Dinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkExtent3D callocStack(MemoryStack stack)
Returns a newVkExtent3Dinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkExtent3D.Buffer mallocStack(int capacity)
Returns a newVkExtent3D.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkExtent3D.Buffer callocStack(int capacity)
Returns a newVkExtent3D.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkExtent3D.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkExtent3D.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkExtent3D.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkExtent3D.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-