Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkRect2D

extends Struct<VkRect2D>
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 two-dimensional subregion.
See Also

VkBindImageMemoryDeviceGroupInfo, VkClearRect, VkCommandBufferInheritanceRenderPassTransformInfoQCOM, VkDeviceGroupRenderPassBeginInfo, VkDisplayPresentInfoKHR, VkExtent2D, VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM, VkOffset2D, VkOpticalFlowExecuteInfoNV, VkPipelineDiscardRectangleStateCreateInfoEXT, VkPipelineViewportExclusiveScissorStateCreateInfoNV, VkPipelineViewportStateCreateInfo, VkRenderPassBeginInfo, VkRenderingInfo, CmdSetDiscardRectangleEXT, CmdSetExclusiveScissorNV, CmdSetScissor, CmdSetScissorWithCount, CmdSetScissorWithCountEXT, GetPhysicalDevicePresentRectanglesKHR

Layout


struct VkRect2D {
    VkOffset2D offset;
    VkExtent2D extent;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkRect2D.Buffer

An array of VkRect2D structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
EXTENT

The struct member offsets.

public static final int
OFFSET

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkRect2D(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkRect2D
calloc()

Returns a new VkRect2D instance allocated with memCalloc.

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

Returns a new VkRect2D.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkRect2D
callocStack()

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

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

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

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

Returns a new VkRect2D instance allocated with BufferUtils.

public static VkRect2D
create(long address)

Returns a new VkRect2D instance for the specified memory address.

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

Returns a new VkRect2D.Buffer instance allocated with BufferUtils.

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

Create a VkRect2D.Buffer instance at the specified memory.

public static VkRect2D
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public VkExtent2D
extent()

a VkExtent2D specifying the rectangle extent.

public VkRect2D
extent(VkExtent2D value)

Copies the specified VkExtent2D to the extent field.

public VkRect2D
extent(Consumer<VkExtent2D> consumer)

Passes the extent field to the specified Consumer.

public static VkRect2D
malloc()

Returns a new VkRect2D instance allocated with memAlloc.

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

Returns a new VkRect2D.Buffer instance allocated with memAlloc.

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

Returns a new VkRect2D instance allocated on the specified MemoryStack.

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

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

public static VkRect2D
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static VkExtent2D
nextent(long struct)

Unsafe version of extent.

public static void
nextent(long struct, VkExtent2D value)

Unsafe version of extent.

public static VkOffset2D
noffset(long struct)

Unsafe version of offset.

public static void
noffset(long struct, VkOffset2D value)

Unsafe version of offset.

public VkOffset2D
offset()

a VkOffset2D specifying the rectangle offset.

public VkRect2D
offset(VkOffset2D value)

Copies the specified VkOffset2D to the offset field.

public VkRect2D
offset(Consumer<VkOffset2D> consumer)

Passes the offset field to the specified Consumer.

public VkRect2D
set(VkOffset2D offset, VkExtent2D extent)

Initializes this struct with the specified values.

public VkRect2D

Returns:

this struct
set
(VkRect2D
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).
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.

EXTENTback to summary
public static final int EXTENT

The struct member offsets.

OFFSETback to summary
public static final int OFFSET

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkRect2Dback to summary
protected VkRect2D(long address, ByteBuffer container)
VkRect2Dback to summary
public VkRect2D(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkRect2D calloc(MemoryStack stack)

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

Returns a new VkRect2D.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 VkRect2D callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkRect2D.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 VkRect2D 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 VkRect2D create()

Returns a new VkRect2D instance allocated with BufferUtils.

createback to summary
public static VkRect2D create(long address)

Returns a new VkRect2D instance for the specified memory address.

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

Returns a new VkRect2D.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkRect2D.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkRect2D createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
extentback to summary
public VkExtent2D extent()

a VkExtent2D specifying the rectangle extent.

extentback to summary
public VkRect2D extent(VkExtent2D value)

Copies the specified VkExtent2D to the extent field.

extentback to summary
public VkRect2D extent(Consumer<VkExtent2D> consumer)

Passes the extent field to the specified Consumer.

mallocback to summary
public static VkRect2D malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkRect2D malloc(MemoryStack stack)

Returns a new VkRect2D instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new VkRect2D.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 VkRect2D mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nextentback to summary
public static VkExtent2D nextent(long struct)

Unsafe version of extent.

nextentback to summary
public static void nextent(long struct, VkExtent2D value)

Unsafe version of extent.

noffsetback to summary
public static VkOffset2D noffset(long struct)

Unsafe version of offset.

noffsetback to summary
public static void noffset(long struct, VkOffset2D value)

Unsafe version of offset.

offsetback to summary
public VkOffset2D offset()

a VkOffset2D specifying the rectangle offset.

offsetback to summary
public VkRect2D offset(VkOffset2D value)

Copies the specified VkOffset2D to the offset field.

offsetback to summary
public VkRect2D offset(Consumer<VkOffset2D> consumer)

Passes the offset field to the specified Consumer.

setback to summary
public VkRect2D set(VkOffset2D offset, VkExtent2D extent)

Initializes this struct with the specified values.

setback to summary
public VkRect2D set(VkRect2D src)

Copies the specified struct data to this struct.

Parameters
src:VkRect2D

the source struct

Returns:VkRect2D

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
org.lwjgl.vulkan back to summary

public Class VkRect2D.Buffer

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

An array of VkRect2D structs.

Field Summary

Modifier and TypeField and Description
private static final VkRect2D

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkRect2D.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 VkExtent2D

Returns:

a VkExtent2D view of the VkRect2D#extent field.
extent
()

public VkRect2D.Buffer
extent(VkExtent2D value)

Copies the specified VkExtent2D to the VkRect2D#extent field.

public VkRect2D.Buffer
extent(Consumer<VkExtent2D> consumer)

Passes the VkRect2D#extent field to the specified Consumer.

protected VkRect2D
public VkOffset2D

Returns:

a VkOffset2D view of the VkRect2D#offset field.
offset
()

public VkRect2D.Buffer
offset(VkOffset2D value)

Copies the specified VkOffset2D to the VkRect2D#offset field.

public VkRect2D.Buffer
offset(Consumer<VkOffset2D> consumer)

Passes the VkRect2D#offset field to the specified Consumer.

protected VkRect2D.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkRect2D ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

extentback to summary
public VkExtent2D extent()
Returns:VkExtent2D

a VkExtent2D view of the VkRect2D#extent field.

extentback to summary
public VkRect2D.Buffer extent(VkExtent2D value)

Copies the specified VkExtent2D to the VkRect2D#extent field.

extentback to summary
public VkRect2D.Buffer extent(Consumer<VkExtent2D> consumer)

Passes the VkRect2D#extent field to the specified Consumer.

getElementFactoryback to summary
protected VkRect2D getElementFactory()

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

Annotations
@Override
offsetback to summary
public VkOffset2D offset()
Returns:VkOffset2D

a VkOffset2D view of the VkRect2D#offset field.

offsetback to summary
public VkRect2D.Buffer offset(VkOffset2D value)

Copies the specified VkOffset2D to the VkRect2D#offset field.

offsetback to summary
public VkRect2D.Buffer offset(Consumer<VkOffset2D> consumer)

Passes the VkRect2D#offset field to the specified Consumer.

selfback to summary
protected VkRect2D.Buffer self()

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

Annotations
@Override