Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPresentRegionKHR

extends Struct<VkPresentRegionKHR>
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 containing rectangular region changed by vkQueuePresentKHR for a given VkImage.
Valid Usage (Implicit)
See Also

VkPresentRegionsKHR, VkRectLayerKHR

Layout


struct VkPresentRegionKHR {
    uint32_t rectangleCount;
    VkRectLayerKHR const * pRectangles;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PRECTANGLES

The struct member offsets.

public static final int
RECTANGLECOUNT

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
VkPresentRegionKHR(long address, ByteBuffer container)

public
VkPresentRegionKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkPresentRegionKHR
calloc()

Returns a new VkPresentRegionKHR instance allocated with memCalloc.

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

Returns a new VkPresentRegionKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkPresentRegionKHR
callocStack()

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

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

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

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

Returns a new VkPresentRegionKHR instance allocated with BufferUtils.

public static VkPresentRegionKHR
create(long address)

Returns a new VkPresentRegionKHR instance for the specified memory address.

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

Returns a new VkPresentRegionKHR.Buffer instance allocated with BufferUtils.

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

Create a VkPresentRegionKHR.Buffer instance at the specified memory.

public static VkPresentRegionKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkPresentRegionKHR
malloc()

Returns a new VkPresentRegionKHR instance allocated with memAlloc.

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

Returns a new VkPresentRegionKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkPresentRegionKHR instance allocated on the specified MemoryStack.

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

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

public static VkPresentRegionKHR
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static VkRectLayerKHR.Buffer
npRectangles(long struct)

Unsafe version of pRectangles.

public static void
npRectangles(long struct, VkRectLayerKHR.Buffer value)

Unsafe version of pRectangles.

public static int
nrectangleCount(long struct)

Unsafe version of rectangleCount.

public static void
nrectangleCount(long struct, int value)

Sets the specified value to the rectangleCount field of the specified struct.

public VkRectLayerKHR.Buffer
pRectangles()

either NULL or a pointer to an array of VkRectLayerKHR structures.

public VkPresentRegionKHR
pRectangles(VkRectLayerKHR.Buffer value)

Sets the address of the specified VkRectLayerKHR.Buffer to the pRectangles field.

public int
rectangleCount()

the number of rectangles in pRectangles, or zero if the entire image has changed and should be presented.

public VkPresentRegionKHR
rectangleCount(int value)

Sets the specified value to the rectangleCount field.

public VkPresentRegionKHR
set(int rectangleCount, VkRectLayerKHR.Buffer pRectangles)

Initializes this struct with the specified values.

public VkPresentRegionKHR

Returns:

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

PRECTANGLESback to summary
public static final int PRECTANGLES

The struct member offsets.

RECTANGLECOUNTback to summary
public static final int RECTANGLECOUNT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkPresentRegionKHRback to summary
protected VkPresentRegionKHR(long address, ByteBuffer container)
VkPresentRegionKHRback to summary
public VkPresentRegionKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPresentRegionKHR calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkPresentRegionKHR instance allocated with BufferUtils.

createback to summary
public static VkPresentRegionKHR create(long address)

Returns a new VkPresentRegionKHR instance for the specified memory address.

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

Returns a new VkPresentRegionKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPresentRegionKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPresentRegionKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkPresentRegionKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPresentRegionKHR malloc(MemoryStack stack)

Returns a new VkPresentRegionKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
npRectanglesback to summary
public static VkRectLayerKHR.Buffer npRectangles(long struct)

Unsafe version of pRectangles.

Annotations
@Nullable
npRectanglesback to summary
public static void npRectangles(long struct, VkRectLayerKHR.Buffer value)

Unsafe version of pRectangles.

nrectangleCountback to summary
public static int nrectangleCount(long struct)

Unsafe version of rectangleCount.

nrectangleCountback to summary
public static void nrectangleCount(long struct, int value)

Sets the specified value to the rectangleCount field of the specified struct.

pRectanglesback to summary
public VkRectLayerKHR.Buffer pRectangles()

either NULL or a pointer to an array of VkRectLayerKHR structures. The VkRectLayerKHR structure is the framebuffer coordinates, plus layer, of a portion of a presentable image that has changed and must be presented. If non-NULL, each entry in pRectangles is a rectangle of the given image that has changed since the last image was presented to the given swapchain. The rectangles must be specified relative to VkSurfaceCapabilitiesKHR::currentTransform, regardless of the swapchain’s preTransform. The presentation engine will apply the preTransform transformation to the rectangles, along with any further transformation it applies to the image content.

Annotations
@Nullable
@NativeType:VkRectLayerKHR const *
pRectanglesback to summary
public VkPresentRegionKHR pRectangles(VkRectLayerKHR.Buffer value)

Sets the address of the specified VkRectLayerKHR.Buffer to the pRectangles field.

rectangleCountback to summary
public int rectangleCount()

the number of rectangles in pRectangles, or zero if the entire image has changed and should be presented.

Annotations
@NativeType:uint32_t
rectangleCountback to summary
public VkPresentRegionKHR rectangleCount(int value)

Sets the specified value to the rectangleCount field.

setback to summary
public VkPresentRegionKHR set(int rectangleCount, VkRectLayerKHR.Buffer pRectangles)

Initializes this struct with the specified values.

setback to summary
public VkPresentRegionKHR set(VkPresentRegionKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkPresentRegionKHR

the source struct

Returns:VkPresentRegionKHR

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 VkPresentRegionKHR.Buffer

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

An array of VkPresentRegionKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkPresentRegionKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPresentRegionKHR.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
protected VkPresentRegionKHR
public VkRectLayerKHR.Buffer

Returns:

a VkRectLayerKHR.Buffer view of the struct array pointed to by the VkPresentRegionKHR#pRectangles field.
pRectangles
()

public VkPresentRegionKHR.Buffer
pRectangles(VkRectLayerKHR.Buffer value)

Sets the address of the specified VkRectLayerKHR.Buffer to the VkPresentRegionKHR#pRectangles field.

public int

Returns:

the value of the VkPresentRegionKHR#rectangleCount field.
rectangleCount
()

public VkPresentRegionKHR.Buffer
rectangleCount(int value)

Sets the specified value to the VkPresentRegionKHR#rectangleCount field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPresentRegionKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected VkPresentRegionKHR getElementFactory()

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

Annotations
@Override
pRectanglesback to summary
public VkRectLayerKHR.Buffer pRectangles()
Returns:VkRectLayerKHR.Buffer

a VkRectLayerKHR.Buffer view of the struct array pointed to by the VkPresentRegionKHR#pRectangles field.

Annotations
@Nullable
@NativeType:VkRectLayerKHR const *
pRectanglesback to summary
public VkPresentRegionKHR.Buffer pRectangles(VkRectLayerKHR.Buffer value)

Sets the address of the specified VkRectLayerKHR.Buffer to the VkPresentRegionKHR#pRectangles field.

rectangleCountback to summary
public int rectangleCount()
Returns:int

the value of the VkPresentRegionKHR#rectangleCount field.

Annotations
@NativeType:uint32_t
rectangleCountback to summary
public VkPresentRegionKHR.Buffer rectangleCount(int value)

Sets the specified value to the VkPresentRegionKHR#rectangleCount field.

selfback to summary
protected VkPresentRegionKHR.Buffer self()

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

Annotations
@Override