org.lwjgl.vulkan.VkDeviceGroupRenderPassBeginInfoKHX 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.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Set the initial device mask and render areas for a render pass instance.
*
* Description
*
* The {@code deviceMask} serves several purposes. It is an upper bound on the set of physical devices that can be used during the render pass instance, and the initial device mask when the render pass instance begins. Render pass attachment load, store, and resolve operations only apply to physical devices included in the device mask. Subpass dependencies only apply to the physical devices in the device mask.
*
* If {@code deviceRenderAreaCount} is not zero, then the elements of {@code pDeviceRenderAreas} override the value of {@link VkRenderPassBeginInfo}{@code ::renderArea}, and provide a render area specific to each physical device. These render areas serve the same purpose as {@link VkRenderPassBeginInfo}{@code ::renderArea}, including controlling the region of attachments that are cleared by {@link VK10#VK_ATTACHMENT_LOAD_OP_CLEAR ATTACHMENT_LOAD_OP_CLEAR} and that are resolved into resolve attachments.
*
* If this structure is not present, the render pass instance's device mask is the value of {@link VkDeviceGroupCommandBufferBeginInfoKHX}{@code ::deviceMask}. If this structure is not present or if {@code deviceRenderAreaCount} is zero, {@link VkRenderPassBeginInfo}{@code ::renderArea} is used for all physical devices.
*
* Valid Usage
*
*
* - {@code deviceMask} must be a valid device mask value
* - {@code deviceMask} must not be zero
* - {@code deviceMask} must be a subset of the command buffer’s initial device mask
* - {@code deviceRenderAreaCount} must either be zero or equal to the number of physical devices in the logical device.
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link KHXDeviceGroup#VK_STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO_KHX STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO_KHX}
* - If {@code deviceRenderAreaCount} is not 0, {@code pDeviceRenderAreas} must be a pointer to an array of {@code deviceRenderAreaCount} {@link VkRect2D} structures
*
*
* See Also
*
* {@link VkRect2D}
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code deviceMask} – the device mask for the render pass instance.
* - {@code deviceRenderAreaCount} – the number of elements in the {@code pDeviceRenderAreas} array.
* - {@code pDeviceRenderAreas} – an array of structures of type {@link VkRect2D} defining the render area for each physical device.
*
*
* Layout
*
*
* struct VkDeviceGroupRenderPassBeginInfoKHX {
* VkStructureType sType;
* const void * pNext;
* uint32_t deviceMask;
* uint32_t deviceRenderAreaCount;
* const {@link VkRect2D VkRect2D} * pDeviceRenderAreas;
* }The created instance holds a strong reference to the container object.
*/
public VkDeviceGroupRenderPassBeginInfoKHX(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 deviceMask} field. */
@NativeType("uint32_t")
public int deviceMask() { return ndeviceMask(address()); }
/** Returns the value of the {@code deviceRenderAreaCount} field. */
@NativeType("uint32_t")
public int deviceRenderAreaCount() { return ndeviceRenderAreaCount(address()); }
/** Returns a {@link VkRect2D.Buffer} view of the struct array pointed to by the {@code pDeviceRenderAreas} field. */
@NativeType("const VkRect2D *")
public VkRect2D.Buffer pDeviceRenderAreas() { return npDeviceRenderAreas(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkDeviceGroupRenderPassBeginInfoKHX sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkDeviceGroupRenderPassBeginInfoKHX pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code deviceMask} field. */
public VkDeviceGroupRenderPassBeginInfoKHX deviceMask(@NativeType("uint32_t") int value) { ndeviceMask(address(), value); return this; }
/** Sets the address of the specified {@link VkRect2D.Buffer} to the {@code pDeviceRenderAreas} field. */
public VkDeviceGroupRenderPassBeginInfoKHX pDeviceRenderAreas(@NativeType("const VkRect2D *") VkRect2D.Buffer value) { npDeviceRenderAreas(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkDeviceGroupRenderPassBeginInfoKHX set(
int sType,
long pNext,
int deviceMask,
VkRect2D.Buffer pDeviceRenderAreas
) {
sType(sType);
pNext(pNext);
deviceMask(deviceMask);
pDeviceRenderAreas(pDeviceRenderAreas);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkDeviceGroupRenderPassBeginInfoKHX set(VkDeviceGroupRenderPassBeginInfoKHX src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkDeviceGroupRenderPassBeginInfoKHX} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkDeviceGroupRenderPassBeginInfoKHX malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link VkDeviceGroupRenderPassBeginInfoKHX} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkDeviceGroupRenderPassBeginInfoKHX calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link VkDeviceGroupRenderPassBeginInfoKHX} instance allocated with {@link BufferUtils}. */
public static VkDeviceGroupRenderPassBeginInfoKHX create() {
return new VkDeviceGroupRenderPassBeginInfoKHX(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkDeviceGroupRenderPassBeginInfoKHX} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static VkDeviceGroupRenderPassBeginInfoKHX create(long address) {
return address == NULL ? null : new VkDeviceGroupRenderPassBeginInfoKHX(address, null);
}
/**
* Returns a new {@link VkDeviceGroupRenderPassBeginInfoKHX.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 VkDeviceGroupRenderPassBeginInfoKHX.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 VkDeviceGroupRenderPassBeginInfoKHX.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 VkDeviceGroupRenderPassBeginInfoKHX.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 VkDeviceGroupRenderPassBeginInfoKHX} instance allocated on the thread-local {@link MemoryStack}. */
public static VkDeviceGroupRenderPassBeginInfoKHX mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkDeviceGroupRenderPassBeginInfoKHX} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkDeviceGroupRenderPassBeginInfoKHX callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkDeviceGroupRenderPassBeginInfoKHX} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkDeviceGroupRenderPassBeginInfoKHX mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkDeviceGroupRenderPassBeginInfoKHX} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkDeviceGroupRenderPassBeginInfoKHX callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkDeviceGroupRenderPassBeginInfoKHX.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 VkDeviceGroupRenderPassBeginInfoKHX.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 VkDeviceGroupRenderPassBeginInfoKHX.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 VkDeviceGroupRenderPassBeginInfoKHX.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 + VkDeviceGroupRenderPassBeginInfoKHX.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkDeviceGroupRenderPassBeginInfoKHX.PNEXT); }
/** Unsafe version of {@link #deviceMask}. */
public static int ndeviceMask(long struct) { return memGetInt(struct + VkDeviceGroupRenderPassBeginInfoKHX.DEVICEMASK); }
/** Unsafe version of {@link #deviceRenderAreaCount}. */
public static int ndeviceRenderAreaCount(long struct) { return memGetInt(struct + VkDeviceGroupRenderPassBeginInfoKHX.DEVICERENDERAREACOUNT); }
/** Unsafe version of {@link #pDeviceRenderAreas}. */
public static VkRect2D.Buffer npDeviceRenderAreas(long struct) { return VkRect2D.create(memGetAddress(struct + VkDeviceGroupRenderPassBeginInfoKHX.PDEVICERENDERAREAS), ndeviceRenderAreaCount(struct)); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkDeviceGroupRenderPassBeginInfoKHX.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkDeviceGroupRenderPassBeginInfoKHX.PNEXT, value); }
/** Unsafe version of {@link #deviceMask(int) deviceMask}. */
public static void ndeviceMask(long struct, int value) { memPutInt(struct + VkDeviceGroupRenderPassBeginInfoKHX.DEVICEMASK, value); }
/** Sets the specified value to the {@code deviceRenderAreaCount} field of the specified {@code struct}. */
public static void ndeviceRenderAreaCount(long struct, int value) { memPutInt(struct + VkDeviceGroupRenderPassBeginInfoKHX.DEVICERENDERAREACOUNT, value); }
/** Unsafe version of {@link #pDeviceRenderAreas(VkRect2D.Buffer) pDeviceRenderAreas}. */
public static void npDeviceRenderAreas(long struct, VkRect2D.Buffer value) { memPutAddress(struct + VkDeviceGroupRenderPassBeginInfoKHX.PDEVICERENDERAREAS, memAddressSafe(value)); ndeviceRenderAreaCount(struct, value == null ? 0 : value.remaining()); }
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
if (ndeviceRenderAreaCount(struct) != 0) {
check(memGetAddress(struct + VkDeviceGroupRenderPassBeginInfoKHX.PDEVICERENDERAREAS));
}
}
/**
* Calls {@link #validate(long)} for each struct contained in the specified struct array.
*
* @param array the struct array to validate
* @param count the number of structs in {@code array}
*/
public static void validate(long array, int count) {
for (int i = 0; i < count; i++) {
validate(array + i * SIZEOF);
}
}
// -----------------------------------
/** An array of {@link VkDeviceGroupRenderPassBeginInfoKHX} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkDeviceGroupRenderPassBeginInfoKHX.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 VkDeviceGroupRenderPassBeginInfoKHX#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 VkDeviceGroupRenderPassBeginInfoKHX newInstance(long address) {
return new VkDeviceGroupRenderPassBeginInfoKHX(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkDeviceGroupRenderPassBeginInfoKHX.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkDeviceGroupRenderPassBeginInfoKHX.npNext(address()); }
/** Returns the value of the {@code deviceMask} field. */
@NativeType("uint32_t")
public int deviceMask() { return VkDeviceGroupRenderPassBeginInfoKHX.ndeviceMask(address()); }
/** Returns the value of the {@code deviceRenderAreaCount} field. */
@NativeType("uint32_t")
public int deviceRenderAreaCount() { return VkDeviceGroupRenderPassBeginInfoKHX.ndeviceRenderAreaCount(address()); }
/** Returns a {@link VkRect2D.Buffer} view of the struct array pointed to by the {@code pDeviceRenderAreas} field. */
@NativeType("const VkRect2D *")
public VkRect2D.Buffer pDeviceRenderAreas() { return VkDeviceGroupRenderPassBeginInfoKHX.npDeviceRenderAreas(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkDeviceGroupRenderPassBeginInfoKHX.Buffer sType(@NativeType("VkStructureType") int value) { VkDeviceGroupRenderPassBeginInfoKHX.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkDeviceGroupRenderPassBeginInfoKHX.Buffer pNext(@NativeType("const void *") long value) { VkDeviceGroupRenderPassBeginInfoKHX.npNext(address(), value); return this; }
/** Sets the specified value to the {@code deviceMask} field. */
public VkDeviceGroupRenderPassBeginInfoKHX.Buffer deviceMask(@NativeType("uint32_t") int value) { VkDeviceGroupRenderPassBeginInfoKHX.ndeviceMask(address(), value); return this; }
/** Sets the address of the specified {@link VkRect2D.Buffer} to the {@code pDeviceRenderAreas} field. */
public VkDeviceGroupRenderPassBeginInfoKHX.Buffer pDeviceRenderAreas(@NativeType("const VkRect2D *") VkRect2D.Buffer value) { VkDeviceGroupRenderPassBeginInfoKHX.npDeviceRenderAreas(address(), value); return this; }
}
}