Package org.lwjgl.vulkan
Class VkRect2D
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkRect2D
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkRect2D extends Struct
Khronos Reference Page
Vulkan SpecificationDescribes a 2D rectangular region.
Member documentation
offset
– the region offsetextent
– the region extent
Layout
struct VkRect2D {
VkOffset2D
offset;VkExtent2D
extent; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkRect2D.Buffer
An array ofVkRect2D
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkRect2D
calloc()
static VkRect2D.Buffer
calloc(int capacity)
Returns a newVkRect2D.Buffer
instance allocated withmemCalloc
.static VkRect2D
callocStack()
Returns a newVkRect2D
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkRect2D.Buffer
callocStack(int capacity)
Returns a newVkRect2D.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkRect2D.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkRect2D.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkRect2D
callocStack(MemoryStack stack)
Returns a newVkRect2D
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkRect2D
create()
Returns a newVkRect2D
instance allocated withBufferUtils
.static VkRect2D.Buffer
create(int capacity)
Returns a newVkRect2D.Buffer
instance allocated withBufferUtils
.static VkRect2D
create(long address)
static VkRect2D.Buffer
create(long address, int capacity)
Create aVkRect2D.Buffer
instance at the specified memory.VkExtent2D
extent()
Returns aVkExtent2D
view of theextent
field.VkRect2D
extent(VkExtent2D value)
Copies the specifiedVkExtent2D
to theextent
field.static VkRect2D
malloc()
static VkRect2D.Buffer
malloc(int capacity)
Returns a newVkRect2D.Buffer
instance allocated withmemAlloc
.static VkRect2D
mallocStack()
Returns a newVkRect2D
instance allocated on the thread-localMemoryStack
.static VkRect2D.Buffer
mallocStack(int capacity)
Returns a newVkRect2D.Buffer
instance allocated on the thread-localMemoryStack
.static VkRect2D.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkRect2D.Buffer
instance allocated on the specifiedMemoryStack
.static VkRect2D
mallocStack(MemoryStack stack)
Returns a newVkRect2D
instance allocated on the specifiedMemoryStack
.VkRect2D
nset(long struct)
Unsafe version ofset
.VkOffset2D
offset()
Returns aVkOffset2D
view of theoffset
field.VkRect2D
offset(VkOffset2D value)
Copies the specifiedVkOffset2D
to theoffset
field.VkRect2D
set(VkOffset2D offset, VkExtent2D extent)
Initializes this struct with the specified values.VkRect2D
set(VkRect2D src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkRect2D
public VkRect2D(java.nio.ByteBuffer container)
Creates aVkRect2D
instance at the current position of the specifiedByteBuffer
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
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
offset
public VkOffset2D offset()
Returns aVkOffset2D
view of theoffset
field.
-
extent
public VkExtent2D extent()
Returns aVkExtent2D
view of theextent
field.
-
offset
public VkRect2D offset(VkOffset2D value)
Copies the specifiedVkOffset2D
to theoffset
field.
-
extent
public VkRect2D extent(VkExtent2D value)
Copies the specifiedVkExtent2D
to theextent
field.
-
set
public VkRect2D set(VkOffset2D offset, VkExtent2D extent)
Initializes this struct with the specified values.
-
set
public VkRect2D set(VkRect2D src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkRect2D malloc()
-
calloc
public static VkRect2D calloc()
-
create
public static VkRect2D create()
Returns a newVkRect2D
instance allocated withBufferUtils
.
-
create
public static VkRect2D create(long address)
-
malloc
public static VkRect2D.Buffer malloc(int capacity)
Returns a newVkRect2D.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkRect2D.Buffer calloc(int capacity)
Returns a newVkRect2D.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkRect2D.Buffer create(int capacity)
Returns a newVkRect2D.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkRect2D.Buffer create(long address, int capacity)
Create aVkRect2D.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkRect2D mallocStack()
Returns a newVkRect2D
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkRect2D callocStack()
Returns a newVkRect2D
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkRect2D mallocStack(MemoryStack stack)
Returns a newVkRect2D
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkRect2D callocStack(MemoryStack stack)
Returns a newVkRect2D
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkRect2D.Buffer mallocStack(int capacity)
Returns a newVkRect2D.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkRect2D.Buffer callocStack(int capacity)
Returns a newVkRect2D.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkRect2D.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkRect2D.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkRect2D.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkRect2D.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-