Package org.lwjgl.vulkan
Class VkRectLayerKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkRectLayerKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkRectLayerKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure containing a rectangle, including layer, changed by vkQueuePresentKHR for a given VkImage.Valid Usage
- The sum of
offsetandextentmust be no greater than theimageExtentmember of theVkSwapchainCreateInfoKHRstructure given toCreateSwapchainKHR. layermust be less thanimageArrayLayersmember of theVkSwapchainCreateInfoKHRstructure given toCreateSwapchainKHR.
Some platforms allow the size of a surface to change, and then scale the pixels of the image to fit the surface.
VkRectLayerKHRspecifies pixels of the swapchain's image(s), which will be constant for the life of the swapchain.See Also
VkExtent2D,VkOffset2D,VkPresentRegionKHRMember documentation
offset– the origin of the rectangle, in pixels.extent– the size of the rectangle, in pixels.layer– the layer of the image. For images with only one layer, the value oflayermust be 0.
Layout
struct VkRectLayerKHR {VkOffset2Doffset;VkExtent2Dextent; uint32_t layer; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkRectLayerKHR.BufferAn array ofVkRectLayerKHRstructs.
-
Constructor Summary
Constructors Constructor Description VkRectLayerKHR(java.nio.ByteBuffer container)Creates aVkRectLayerKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkRectLayerKHRcalloc()Returns a newVkRectLayerKHRinstance allocated withmemCalloc.static VkRectLayerKHR.Buffercalloc(int capacity)Returns a newVkRectLayerKHR.Bufferinstance allocated withmemCalloc.static VkRectLayerKHRcallocStack()Returns a newVkRectLayerKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkRectLayerKHR.BuffercallocStack(int capacity)Returns a newVkRectLayerKHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkRectLayerKHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkRectLayerKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkRectLayerKHRcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkRectLayerKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkRectLayerKHRcreate()Returns a newVkRectLayerKHRinstance allocated withBufferUtils.static VkRectLayerKHR.Buffercreate(int capacity)Returns a newVkRectLayerKHR.Bufferinstance allocated withBufferUtils.static VkRectLayerKHRcreate(long address)Returns a newVkRectLayerKHRinstance for the specified memory address.static VkRectLayerKHR.Buffercreate(long address, int capacity)Create aVkRectLayerKHR.Bufferinstance at the specified memory.static VkRectLayerKHRcreateSafe(long address)static VkRectLayerKHR.BuffercreateSafe(long address, int capacity)VkExtent2Dextent()Returns aVkExtent2Dview of theextentfield.VkRectLayerKHRextent(java.util.function.Consumer<VkExtent2D> consumer)Passes theextentfield to the specifiedConsumer.VkRectLayerKHRextent(VkExtent2D value)Copies the specifiedVkExtent2Dto theextentfield.intlayer()Returns the value of thelayerfield.VkRectLayerKHRlayer(int value)Sets the specified value to thelayerfield.static VkRectLayerKHRmalloc()Returns a newVkRectLayerKHRinstance allocated withmemAlloc.static VkRectLayerKHR.Buffermalloc(int capacity)Returns a newVkRectLayerKHR.Bufferinstance allocated withmemAlloc.static VkRectLayerKHRmallocStack()Returns a newVkRectLayerKHRinstance allocated on the thread-localMemoryStack.static VkRectLayerKHR.BuffermallocStack(int capacity)Returns a newVkRectLayerKHR.Bufferinstance allocated on the thread-localMemoryStack.static VkRectLayerKHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkRectLayerKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkRectLayerKHRmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkRectLayerKHRinstance allocated on the specifiedMemoryStack.static VkExtent2Dnextent(long struct)Unsafe version ofextent().static voidnextent(long struct, VkExtent2D value)Unsafe version ofextent.static intnlayer(long struct)Unsafe version oflayer().static voidnlayer(long struct, int value)Unsafe version oflayer.static VkOffset2Dnoffset(long struct)Unsafe version ofoffset().static voidnoffset(long struct, VkOffset2D value)Unsafe version ofoffset.VkOffset2Doffset()Returns aVkOffset2Dview of theoffsetfield.VkRectLayerKHRoffset(java.util.function.Consumer<VkOffset2D> consumer)Passes theoffsetfield to the specifiedConsumer.VkRectLayerKHRoffset(VkOffset2D value)Copies the specifiedVkOffset2Dto theoffsetfield.VkRectLayerKHRset(VkOffset2D offset, VkExtent2D extent, int layer)Initializes this struct with the specified values.VkRectLayerKHRset(VkRectLayerKHR src)Copies the specified struct data to this struct.intsizeof()
-
-
-
Constructor Detail
-
VkRectLayerKHR
public VkRectLayerKHR(java.nio.ByteBuffer container)
Creates aVkRectLayerKHRinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
offset
public VkOffset2D offset()
Returns aVkOffset2Dview of theoffsetfield.
-
extent
public VkExtent2D extent()
Returns aVkExtent2Dview of theextentfield.
-
layer
public int layer()
Returns the value of thelayerfield.
-
offset
public VkRectLayerKHR offset(VkOffset2D value)
Copies the specifiedVkOffset2Dto theoffsetfield.
-
offset
public VkRectLayerKHR offset(java.util.function.Consumer<VkOffset2D> consumer)
Passes theoffsetfield to the specifiedConsumer.
-
extent
public VkRectLayerKHR extent(VkExtent2D value)
Copies the specifiedVkExtent2Dto theextentfield.
-
extent
public VkRectLayerKHR extent(java.util.function.Consumer<VkExtent2D> consumer)
Passes theextentfield to the specifiedConsumer.
-
layer
public VkRectLayerKHR layer(int value)
Sets the specified value to thelayerfield.
-
set
public VkRectLayerKHR set(VkOffset2D offset, VkExtent2D extent, int layer)
Initializes this struct with the specified values.
-
set
public VkRectLayerKHR set(VkRectLayerKHR src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkRectLayerKHR malloc()
Returns a newVkRectLayerKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkRectLayerKHR calloc()
Returns a newVkRectLayerKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkRectLayerKHR create()
Returns a newVkRectLayerKHRinstance allocated withBufferUtils.
-
create
public static VkRectLayerKHR create(long address)
Returns a newVkRectLayerKHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkRectLayerKHR createSafe(long address)
-
malloc
public static VkRectLayerKHR.Buffer malloc(int capacity)
Returns a newVkRectLayerKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkRectLayerKHR.Buffer calloc(int capacity)
Returns a newVkRectLayerKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkRectLayerKHR.Buffer create(int capacity)
Returns a newVkRectLayerKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkRectLayerKHR.Buffer create(long address, int capacity)
Create aVkRectLayerKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkRectLayerKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkRectLayerKHR mallocStack()
Returns a newVkRectLayerKHRinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkRectLayerKHR callocStack()
Returns a newVkRectLayerKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkRectLayerKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkRectLayerKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkRectLayerKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkRectLayerKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkRectLayerKHR.Buffer mallocStack(int capacity)
Returns a newVkRectLayerKHR.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkRectLayerKHR.Buffer callocStack(int capacity)
Returns a newVkRectLayerKHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkRectLayerKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkRectLayerKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkRectLayerKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkRectLayerKHR.Bufferinstance allocated on the specifiedMemoryStackand 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().
-
nlayer
public static int nlayer(long struct)
Unsafe version oflayer().
-
noffset
public static void noffset(long struct, VkOffset2D value)Unsafe version ofoffset.
-
nextent
public static void nextent(long struct, VkExtent2D value)Unsafe version ofextent.
-
nlayer
public static void nlayer(long struct, int value)Unsafe version oflayer.
-
-