Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkRectLayerKHR

extends Struct<VkRectLayerKHR>
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 a rectangle, including layer, changed by vkQueuePresentKHR for a given VkImage.
Description

Some platforms allow the size of a surface to change, and then scale the pixels of the image to fit the surface. VkRectLayerKHR specifies pixels of the swapchain’s image(s), which will be constant for the life of the swapchain.

Valid Usage
See Also

VkExtent2D, VkOffset2D, VkPresentRegionKHR

Layout


struct VkRectLayerKHR {
    VkOffset2D offset;
    VkExtent2D extent;
    uint32_t layer;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkRectLayerKHR.Buffer

An array of VkRectLayerKHR 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
LAYER

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

public
VkRectLayerKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkRectLayerKHR
calloc()

Returns a new VkRectLayerKHR instance allocated with memCalloc.

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

Returns a new VkRectLayerKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkRectLayerKHR
callocStack()

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

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

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

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

Returns a new VkRectLayerKHR instance allocated with BufferUtils.

public static VkRectLayerKHR
create(long address)

Returns a new VkRectLayerKHR instance for the specified memory address.

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

Returns a new VkRectLayerKHR.Buffer instance allocated with BufferUtils.

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

Create a VkRectLayerKHR.Buffer instance at the specified memory.

public static VkRectLayerKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public VkExtent2D
extent()

the size of the rectangle, in pixels.

public VkRectLayerKHR
extent(VkExtent2D value)

Copies the specified VkExtent2D to the extent field.

public VkRectLayerKHR
extent(Consumer<VkExtent2D> consumer)

Passes the extent field to the specified Consumer.

public int
layer()

the layer of the image.

public VkRectLayerKHR
layer(int value)

Sets the specified value to the layer field.

public static VkRectLayerKHR
malloc()

Returns a new VkRectLayerKHR instance allocated with memAlloc.

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

Returns a new VkRectLayerKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkRectLayerKHR instance allocated on the specified MemoryStack.

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

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

public static VkRectLayerKHR
mallocStack()

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static VkRectLayerKHR.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 int
nlayer(long struct)

Unsafe version of layer.

public static void
nlayer(long struct, int value)

Unsafe version of layer.

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()

the origin of the rectangle, in pixels.

public VkRectLayerKHR
offset(VkOffset2D value)

Copies the specified VkOffset2D to the offset field.

public VkRectLayerKHR
offset(Consumer<VkOffset2D> consumer)

Passes the offset field to the specified Consumer.

public VkRectLayerKHR
set(VkOffset2D offset, VkExtent2D extent, int layer)

Initializes this struct with the specified values.

public VkRectLayerKHR

Returns:

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

LAYERback to summary
public static final int LAYER

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

VkRectLayerKHRback to summary
protected VkRectLayerKHR(long address, ByteBuffer container)
VkRectLayerKHRback to summary
public VkRectLayerKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkRectLayerKHR calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkRectLayerKHR instance allocated with BufferUtils.

createback to summary
public static VkRectLayerKHR create(long address)

Returns a new VkRectLayerKHR instance for the specified memory address.

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

Returns a new VkRectLayerKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkRectLayerKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkRectLayerKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
extentback to summary
public VkExtent2D extent()

the size of the rectangle, in pixels.

extentback to summary
public VkRectLayerKHR extent(VkExtent2D value)

Copies the specified VkExtent2D to the extent field.

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

Passes the extent field to the specified Consumer.

layerback to summary
public int layer()

the layer of the image. For images with only one layer, the value of layer must be 0.

Annotations
@NativeType:uint32_t
layerback to summary
public VkRectLayerKHR layer(int value)

Sets the specified value to the layer field.

mallocback to summary
public static VkRectLayerKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkRectLayerKHR malloc(MemoryStack stack)

Returns a new VkRectLayerKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkRectLayerKHR.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.

nlayerback to summary
public static int nlayer(long struct)

Unsafe version of layer.

nlayerback to summary
public static void nlayer(long struct, int value)

Unsafe version of layer.

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()

the origin of the rectangle, in pixels.

offsetback to summary
public VkRectLayerKHR offset(VkOffset2D value)

Copies the specified VkOffset2D to the offset field.

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

Passes the offset field to the specified Consumer.

setback to summary
public VkRectLayerKHR set(VkOffset2D offset, VkExtent2D extent, int layer)

Initializes this struct with the specified values.

setback to summary
public VkRectLayerKHR set(VkRectLayerKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkRectLayerKHR

the source struct

Returns:VkRectLayerKHR

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

extends StructBuffer<VkRectLayerKHR, VkRectLayerKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkRectLayerKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkRectLayerKHR
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkRectLayerKHR.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 VkRectLayerKHR#extent field.
extent()

public VkRectLayerKHR.Buffer
extent(VkExtent2D value)

Copies the specified VkExtent2D to the VkRectLayerKHR#extent field.

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

Passes the VkRectLayerKHR#extent field to the specified Consumer.

protected VkRectLayerKHR
getElementFactory()

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

public int

Returns:

the value of the VkRectLayerKHR#layer field.
layer()

public VkRectLayerKHR.Buffer
layer(int value)

Sets the specified value to the VkRectLayerKHR#layer field.

public VkOffset2D

Returns:

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

public VkRectLayerKHR.Buffer
offset(VkOffset2D value)

Copies the specified VkOffset2D to the VkRectLayerKHR#offset field.

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

Passes the VkRectLayerKHR#offset field to the specified Consumer.

protected VkRectLayerKHR.Buffer
self()

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

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkRectLayerKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkRectLayerKHR.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 VkRectLayerKHR#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 VkRectLayerKHR#extent field.

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

Copies the specified VkExtent2D to the VkRectLayerKHR#extent field.

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

Passes the VkRectLayerKHR#extent field to the specified Consumer.

getElementFactoryback to summary
protected VkRectLayerKHR getElementFactory()

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

Annotations
@Override
layerback to summary
public int layer()
Returns:int

the value of the VkRectLayerKHR#layer field.

Annotations
@NativeType:uint32_t
layerback to summary
public VkRectLayerKHR.Buffer layer(int value)

Sets the specified value to the VkRectLayerKHR#layer field.

offsetback to summary
public VkOffset2D offset()
Returns:VkOffset2D

a VkOffset2D view of the VkRectLayerKHR#offset field.

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

Copies the specified VkOffset2D to the VkRectLayerKHR#offset field.

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

Passes the VkRectLayerKHR#offset field to the specified Consumer.

selfback to summary
protected VkRectLayerKHR.Buffer self()

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

Annotations
@Override