org.lwjgl.vulkan.VkPresentRegionsKHR Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-vulkan Show documentation
Show all versions of lwjgl-vulkan Show documentation
A new generation graphics and compute API that provides high-efficiency, cross-platform access to modern GPUs used in a wide variety of devices from PCs and consoles to mobile phones and embedded platforms.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.vulkan;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure hint of rectangular regions changed by vkQueuePresentKHR.
*
* Valid Usage
*
*
* - {@code swapchainCount} must be the same value as {@link VkPresentInfoKHR}{@code ::swapchainCount}, where {@link VkPresentInfoKHR} is in the pNext-chain of this {@link VkPresentRegionsKHR} structure.
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link KHRIncrementalPresent#VK_STRUCTURE_TYPE_PRESENT_REGIONS_KHR STRUCTURE_TYPE_PRESENT_REGIONS_KHR}
* - If {@code pRegions} is not {@code NULL}, {@code pRegions} must be a valid pointer to an array of {@code swapchainCount} valid {@link VkPresentRegionKHR} structures
* - {@code swapchainCount} must be greater than 0
*
*
* See Also
*
* {@link VkPresentRegionKHR}
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code swapchainCount} – the number of swapchains being presented to by this command.
* - {@code pRegions} – {@code NULL} or a pointer to an array of {@link VkPresentRegionKHR} elements with {@code swapchainCount} entries. If not {@code NULL}, each element of {@code pRegions} contains the region that has changed since the last present to the swapchain in the corresponding entry in the {@link VkPresentInfoKHR}{@code ::pSwapchains} array.
*
*
* Layout
*
*
* struct VkPresentRegionsKHR {
* VkStructureType sType;
* const void * pNext;
* uint32_t swapchainCount;
* const {@link VkPresentRegionKHR VkPresentRegionKHR} * pRegions;
* }
*/
public class VkPresentRegionsKHR extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
STYPE,
PNEXT,
SWAPCHAINCOUNT,
PREGIONS;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(4),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
STYPE = layout.offsetof(0);
PNEXT = layout.offsetof(1);
SWAPCHAINCOUNT = layout.offsetof(2);
PREGIONS = layout.offsetof(3);
}
VkPresentRegionsKHR(long address, @Nullable ByteBuffer container) {
super(address, container);
}
/**
* Creates a {@link VkPresentRegionsKHR} instance at the current position of the specified {@link 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.
*/
public VkPresentRegionsKHR(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return npNext(address()); }
/** Returns the value of the {@code swapchainCount} field. */
@NativeType("uint32_t")
public int swapchainCount() { return nswapchainCount(address()); }
/** Returns a {@link VkPresentRegionKHR.Buffer} view of the struct array pointed to by the {@code pRegions} field. */
@Nullable
@NativeType("const VkPresentRegionKHR *")
public VkPresentRegionKHR.Buffer pRegions() { return npRegions(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkPresentRegionsKHR sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkPresentRegionsKHR pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code swapchainCount} field. */
public VkPresentRegionsKHR swapchainCount(@NativeType("uint32_t") int value) { nswapchainCount(address(), value); return this; }
/** Sets the address of the specified {@link VkPresentRegionKHR.Buffer} to the {@code pRegions} field. */
public VkPresentRegionsKHR pRegions(@Nullable @NativeType("const VkPresentRegionKHR *") VkPresentRegionKHR.Buffer value) { npRegions(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkPresentRegionsKHR set(
int sType,
long pNext,
int swapchainCount,
VkPresentRegionKHR.Buffer pRegions
) {
sType(sType);
pNext(pNext);
swapchainCount(swapchainCount);
pRegions(pRegions);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkPresentRegionsKHR set(VkPresentRegionsKHR src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkPresentRegionsKHR} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkPresentRegionsKHR malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkPresentRegionsKHR} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkPresentRegionsKHR calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkPresentRegionsKHR} instance allocated with {@link BufferUtils}. */
public static VkPresentRegionsKHR create() {
return new VkPresentRegionsKHR(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkPresentRegionsKHR} instance for the specified memory address. */
public static VkPresentRegionsKHR create(long address) {
return new VkPresentRegionsKHR(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkPresentRegionsKHR createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkPresentRegionsKHR.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkPresentRegionsKHR.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkPresentRegionsKHR.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkPresentRegionsKHR.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkPresentRegionsKHR.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkPresentRegionsKHR.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkPresentRegionsKHR.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkPresentRegionsKHR.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkPresentRegionsKHR.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkPresentRegionsKHR} instance allocated on the thread-local {@link MemoryStack}. */
public static VkPresentRegionsKHR mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkPresentRegionsKHR} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkPresentRegionsKHR callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkPresentRegionsKHR} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkPresentRegionsKHR mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkPresentRegionsKHR} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkPresentRegionsKHR callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkPresentRegionsKHR.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkPresentRegionsKHR.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkPresentRegionsKHR.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkPresentRegionsKHR.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkPresentRegionsKHR.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkPresentRegionsKHR.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkPresentRegionsKHR.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkPresentRegionsKHR.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #sType}. */
public static int nsType(long struct) { return memGetInt(struct + VkPresentRegionsKHR.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkPresentRegionsKHR.PNEXT); }
/** Unsafe version of {@link #swapchainCount}. */
public static int nswapchainCount(long struct) { return memGetInt(struct + VkPresentRegionsKHR.SWAPCHAINCOUNT); }
/** Unsafe version of {@link #pRegions}. */
@Nullable public static VkPresentRegionKHR.Buffer npRegions(long struct) { return VkPresentRegionKHR.createSafe(memGetAddress(struct + VkPresentRegionsKHR.PREGIONS), nswapchainCount(struct)); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkPresentRegionsKHR.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkPresentRegionsKHR.PNEXT, value); }
/** Sets the specified value to the {@code swapchainCount} field of the specified {@code struct}. */
public static void nswapchainCount(long struct, int value) { memPutInt(struct + VkPresentRegionsKHR.SWAPCHAINCOUNT, value); }
/** Unsafe version of {@link #pRegions(VkPresentRegionKHR.Buffer) pRegions}. */
public static void npRegions(long struct, @Nullable VkPresentRegionKHR.Buffer value) { memPutAddress(struct + VkPresentRegionsKHR.PREGIONS, memAddressSafe(value)); if (value != null) { nswapchainCount(struct, value.remaining()); } }
// -----------------------------------
/** An array of {@link VkPresentRegionsKHR} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkPresentRegionsKHR.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 {@link VkPresentRegionsKHR#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected Buffer newBufferInstance(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkPresentRegionsKHR newInstance(long address) {
return new VkPresentRegionsKHR(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkPresentRegionsKHR.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkPresentRegionsKHR.npNext(address()); }
/** Returns the value of the {@code swapchainCount} field. */
@NativeType("uint32_t")
public int swapchainCount() { return VkPresentRegionsKHR.nswapchainCount(address()); }
/** Returns a {@link VkPresentRegionKHR.Buffer} view of the struct array pointed to by the {@code pRegions} field. */
@Nullable
@NativeType("const VkPresentRegionKHR *")
public VkPresentRegionKHR.Buffer pRegions() { return VkPresentRegionsKHR.npRegions(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkPresentRegionsKHR.Buffer sType(@NativeType("VkStructureType") int value) { VkPresentRegionsKHR.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkPresentRegionsKHR.Buffer pNext(@NativeType("const void *") long value) { VkPresentRegionsKHR.npNext(address(), value); return this; }
/** Sets the specified value to the {@code swapchainCount} field. */
public VkPresentRegionsKHR.Buffer swapchainCount(@NativeType("uint32_t") int value) { VkPresentRegionsKHR.nswapchainCount(address(), value); return this; }
/** Sets the address of the specified {@link VkPresentRegionKHR.Buffer} to the {@code pRegions} field. */
public VkPresentRegionsKHR.Buffer pRegions(@Nullable @NativeType("const VkPresentRegionKHR *") VkPresentRegionKHR.Buffer value) { VkPresentRegionsKHR.npRegions(address(), value); return this; }
}
}