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
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkRect2D extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying a two-dimensional subregion.Member documentation
offset
– aVkOffset2D
specifying the rectangle offset.extent
– aVkExtent2D
specifying the rectangle extent.
Layout
struct VkRect2D {
VkOffset2D
offset;VkExtent2D
extent; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkRect2D.Buffer
An array ofVkRect2D
structs.
-
Constructor Summary
Constructors Constructor Description VkRect2D(java.nio.ByteBuffer container)
Creates aVkRect2D
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkRect2D
calloc()
Returns a newVkRect2D
instance allocated withmemCalloc
.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, org.lwjgl.system.MemoryStack stack)
Returns a newVkRect2D.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkRect2D
callocStack(org.lwjgl.system.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)
Returns a newVkRect2D
instance for the specified memory address.static VkRect2D.Buffer
create(long address, int capacity)
Create aVkRect2D.Buffer
instance at the specified memory.static VkRect2D
createSafe(long address)
static VkRect2D.Buffer
createSafe(long address, int capacity)
VkExtent2D
extent()
Returns aVkExtent2D
view of theextent
field.VkRect2D
extent(java.util.function.Consumer<VkExtent2D> consumer)
Passes theextent
field to the specifiedConsumer
.VkRect2D
extent(VkExtent2D value)
Copies the specifiedVkExtent2D
to theextent
field.static VkRect2D
malloc()
Returns a newVkRect2D
instance allocated withmemAlloc
.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, org.lwjgl.system.MemoryStack stack)
Returns a newVkRect2D.Buffer
instance allocated on the specifiedMemoryStack
.static VkRect2D
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkRect2D
instance allocated on the specifiedMemoryStack
.static VkExtent2D
nextent(long struct)
Unsafe version ofextent()
.static void
nextent(long struct, VkExtent2D value)
Unsafe version ofextent
.static VkOffset2D
noffset(long struct)
Unsafe version ofoffset()
.static void
noffset(long struct, VkOffset2D value)
Unsafe version ofoffset
.VkOffset2D
offset()
Returns aVkOffset2D
view of theoffset
field.VkRect2D
offset(java.util.function.Consumer<VkOffset2D> consumer)
Passes theoffset
field to the specifiedConsumer
.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()
-
-
-
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()
- Specified by:
sizeof
in classorg.lwjgl.system.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.
-
offset
public VkRect2D offset(java.util.function.Consumer<VkOffset2D> consumer)
Passes theoffset
field to the specifiedConsumer
.
-
extent
public VkRect2D extent(VkExtent2D value)
Copies the specifiedVkExtent2D
to theextent
field.
-
extent
public VkRect2D extent(java.util.function.Consumer<VkExtent2D> consumer)
Passes theextent
field to the specifiedConsumer
.
-
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()
Returns a newVkRect2D
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkRect2D calloc()
Returns a newVkRect2D
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkRect2D create()
Returns a newVkRect2D
instance allocated withBufferUtils
.
-
create
public static VkRect2D create(long address)
Returns a newVkRect2D
instance for the specified memory address.
-
createSafe
@Nullable public static VkRect2D createSafe(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
-
createSafe
@Nullable public static VkRect2D.Buffer createSafe(long address, int 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(org.lwjgl.system.MemoryStack stack)
Returns a newVkRect2D
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkRect2D callocStack(org.lwjgl.system.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, org.lwjgl.system.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, org.lwjgl.system.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
-
noffset
public static VkOffset2D noffset(long struct)
Unsafe version ofoffset()
.
-
nextent
public static VkExtent2D nextent(long struct)
Unsafe version ofextent()
.
-
noffset
public static void noffset(long struct, VkOffset2D value)
Unsafe version ofoffset
.
-
nextent
public static void nextent(long struct, VkExtent2D value)
Unsafe version ofextent
.
-
-