org.lwjgl.vulkan.VkBindImageMemorySwapchainInfoKHX 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 java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure specifying swapchain image memory to bind to.
*
* Description
*
* If {@code swapchain} is not {@code NULL}, the {@code swapchain} and {@code imageIndex} are used to determine the memory that the image is bound to, instead of {@code memory} and {@code memoryOffset}.
*
* Memory can be bound to a swapchain and use the {@code pDeviceIndices} or {@code pSFRRects} members of {@link VkBindImageMemoryDeviceGroupInfoKHX}.
*
* Valid Usage
*
*
* - {@code imageIndex} must be less than the number of images in {@code swapchain}
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link KHXDeviceGroup#VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHX STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHX}
* - {@code swapchain} must be a valid {@code VkSwapchainKHR} handle
*
*
* Host Synchronization
*
*
* - Host access to {@code swapchain} must be externally synchronized
*
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code swapchain} – {@link VK10#VK_NULL_HANDLE NULL_HANDLE} or a swapchain handle.
* - {@code imageIndex} – an image index within {@code swapchain}.
*
*
* Layout
*
*
* struct VkBindImageMemorySwapchainInfoKHX {
* VkStructureType sType;
* const void * pNext;
* VkSwapchainKHR swapchain;
* uint32_t imageIndex;
* }The created instance holds a strong reference to the container object.
*/
public VkBindImageMemorySwapchainInfoKHX(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 swapchain} field. */
@NativeType("VkSwapchainKHR")
public long swapchain() { return nswapchain(address()); }
/** Returns the value of the {@code imageIndex} field. */
@NativeType("uint32_t")
public int imageIndex() { return nimageIndex(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkBindImageMemorySwapchainInfoKHX sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkBindImageMemorySwapchainInfoKHX pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code swapchain} field. */
public VkBindImageMemorySwapchainInfoKHX swapchain(@NativeType("VkSwapchainKHR") long value) { nswapchain(address(), value); return this; }
/** Sets the specified value to the {@code imageIndex} field. */
public VkBindImageMemorySwapchainInfoKHX imageIndex(@NativeType("uint32_t") int value) { nimageIndex(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkBindImageMemorySwapchainInfoKHX set(
int sType,
long pNext,
long swapchain,
int imageIndex
) {
sType(sType);
pNext(pNext);
swapchain(swapchain);
imageIndex(imageIndex);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkBindImageMemorySwapchainInfoKHX set(VkBindImageMemorySwapchainInfoKHX src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkBindImageMemorySwapchainInfoKHX} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkBindImageMemorySwapchainInfoKHX malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link VkBindImageMemorySwapchainInfoKHX} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkBindImageMemorySwapchainInfoKHX calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link VkBindImageMemorySwapchainInfoKHX} instance allocated with {@link BufferUtils}. */
public static VkBindImageMemorySwapchainInfoKHX create() {
return new VkBindImageMemorySwapchainInfoKHX(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkBindImageMemorySwapchainInfoKHX} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static VkBindImageMemorySwapchainInfoKHX create(long address) {
return address == NULL ? null : new VkBindImageMemorySwapchainInfoKHX(address, null);
}
/**
* Returns a new {@link VkBindImageMemorySwapchainInfoKHX.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkBindImageMemorySwapchainInfoKHX.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer calloc(int capacity) {
return create(nmemCalloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkBindImageMemorySwapchainInfoKHX.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkBindImageMemorySwapchainInfoKHX.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static Buffer create(long address, int capacity) {
return address == NULL ? null : new Buffer(address, null, -1, 0, capacity, capacity);
}
// -----------------------------------
/** Returns a new {@link VkBindImageMemorySwapchainInfoKHX} instance allocated on the thread-local {@link MemoryStack}. */
public static VkBindImageMemorySwapchainInfoKHX mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkBindImageMemorySwapchainInfoKHX} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkBindImageMemorySwapchainInfoKHX callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkBindImageMemorySwapchainInfoKHX} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkBindImageMemorySwapchainInfoKHX mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkBindImageMemorySwapchainInfoKHX} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkBindImageMemorySwapchainInfoKHX callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkBindImageMemorySwapchainInfoKHX.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkBindImageMemorySwapchainInfoKHX.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkBindImageMemorySwapchainInfoKHX.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkBindImageMemorySwapchainInfoKHX.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 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 + VkBindImageMemorySwapchainInfoKHX.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkBindImageMemorySwapchainInfoKHX.PNEXT); }
/** Unsafe version of {@link #swapchain}. */
public static long nswapchain(long struct) { return memGetLong(struct + VkBindImageMemorySwapchainInfoKHX.SWAPCHAIN); }
/** Unsafe version of {@link #imageIndex}. */
public static int nimageIndex(long struct) { return memGetInt(struct + VkBindImageMemorySwapchainInfoKHX.IMAGEINDEX); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkBindImageMemorySwapchainInfoKHX.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkBindImageMemorySwapchainInfoKHX.PNEXT, value); }
/** Unsafe version of {@link #swapchain(long) swapchain}. */
public static void nswapchain(long struct, long value) { memPutLong(struct + VkBindImageMemorySwapchainInfoKHX.SWAPCHAIN, value); }
/** Unsafe version of {@link #imageIndex(int) imageIndex}. */
public static void nimageIndex(long struct, int value) { memPutInt(struct + VkBindImageMemorySwapchainInfoKHX.IMAGEINDEX, value); }
// -----------------------------------
/** An array of {@link VkBindImageMemorySwapchainInfoKHX} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkBindImageMemorySwapchainInfoKHX.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 VkBindImageMemorySwapchainInfoKHX#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);
}
Buffer(long address, 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, ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkBindImageMemorySwapchainInfoKHX newInstance(long address) {
return new VkBindImageMemorySwapchainInfoKHX(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkBindImageMemorySwapchainInfoKHX.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkBindImageMemorySwapchainInfoKHX.npNext(address()); }
/** Returns the value of the {@code swapchain} field. */
@NativeType("VkSwapchainKHR")
public long swapchain() { return VkBindImageMemorySwapchainInfoKHX.nswapchain(address()); }
/** Returns the value of the {@code imageIndex} field. */
@NativeType("uint32_t")
public int imageIndex() { return VkBindImageMemorySwapchainInfoKHX.nimageIndex(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkBindImageMemorySwapchainInfoKHX.Buffer sType(@NativeType("VkStructureType") int value) { VkBindImageMemorySwapchainInfoKHX.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkBindImageMemorySwapchainInfoKHX.Buffer pNext(@NativeType("const void *") long value) { VkBindImageMemorySwapchainInfoKHX.npNext(address(), value); return this; }
/** Sets the specified value to the {@code swapchain} field. */
public VkBindImageMemorySwapchainInfoKHX.Buffer swapchain(@NativeType("VkSwapchainKHR") long value) { VkBindImageMemorySwapchainInfoKHX.nswapchain(address(), value); return this; }
/** Sets the specified value to the {@code imageIndex} field. */
public VkBindImageMemorySwapchainInfoKHX.Buffer imageIndex(@NativeType("uint32_t") int value) { VkBindImageMemorySwapchainInfoKHX.nimageIndex(address(), value); return this; }
}
}