org.lwjgl.vulkan.VkClearRect 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 a clear rectangle.
*
* Description
*
* The layers [baseArrayLayer, baseArrayLayer {plus} layerCount) counting from the base layer of the attachment image view are cleared.
*
* See Also
*
* {@link VkRect2D}, {@link VK10#vkCmdClearAttachments CmdClearAttachments}
*
* Member documentation
*
*
* - {@code rect} – the two-dimensional region to be cleared.
* - {@code baseArrayLayer} – the first layer to be cleared.
* - {@code layerCount} – the number of layers to clear.
*
*
* Layout
*
* struct VkClearRect {
{@link VkRect2D VkRect2D} rect;
uint32_t baseArrayLayer;
uint32_t layerCount;
}
*/
public class VkClearRect 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
RECT,
BASEARRAYLAYER,
LAYERCOUNT;
static {
Layout layout = __struct(
__member(VkRect2D.SIZEOF, VkRect2D.ALIGNOF),
__member(4),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
RECT = layout.offsetof(0);
BASEARRAYLAYER = layout.offsetof(1);
LAYERCOUNT = layout.offsetof(2);
}
VkClearRect(long address, ByteBuffer container) {
super(address, container);
}
/**
* Creates a {@link VkClearRect} 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 VkClearRect(ByteBuffer container) {
this(memAddress(container), checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns a {@link VkRect2D} view of the {@code rect} field. */
public VkRect2D rect() { return nrect(address()); }
/** Returns the value of the {@code baseArrayLayer} field. */
public int baseArrayLayer() { return nbaseArrayLayer(address()); }
/** Returns the value of the {@code layerCount} field. */
public int layerCount() { return nlayerCount(address()); }
/** Copies the specified {@link VkRect2D} to the {@code rect} field. */
public VkClearRect rect(VkRect2D value) { nrect(address(), value); return this; }
/** Sets the specified value to the {@code baseArrayLayer} field. */
public VkClearRect baseArrayLayer(int value) { nbaseArrayLayer(address(), value); return this; }
/** Sets the specified value to the {@code layerCount} field. */
public VkClearRect layerCount(int value) { nlayerCount(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkClearRect set(
VkRect2D rect,
int baseArrayLayer,
int layerCount
) {
rect(rect);
baseArrayLayer(baseArrayLayer);
layerCount(layerCount);
return this;
}
/** Unsafe version of {@link #set(VkClearRect) set}. */
public VkClearRect nset(long struct) {
memCopy(struct, address(), SIZEOF);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkClearRect set(VkClearRect src) {
return nset(src.address());
}
// -----------------------------------
/** Returns a new {@link VkClearRect} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkClearRect malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link VkClearRect} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkClearRect calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link VkClearRect} instance allocated with {@link BufferUtils}. */
public static VkClearRect create() {
return new VkClearRect(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkClearRect} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static VkClearRect create(long address) {
return address == NULL ? null : new VkClearRect(address, null);
}
/**
* Returns a new {@link VkClearRect.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(nmemAlloc(capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkClearRect.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 VkClearRect.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static Buffer create(int capacity) {
return new Buffer(BufferUtils.createByteBuffer(capacity * SIZEOF));
}
/**
* Create a {@link VkClearRect.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 VkClearRect} instance allocated on the thread-local {@link MemoryStack}. */
public static VkClearRect mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkClearRect} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkClearRect callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkClearRect} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkClearRect mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkClearRect} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkClearRect callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkClearRect.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 VkClearRect.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 VkClearRect.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 VkClearRect.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 #rect}. */
public static VkRect2D nrect(long struct) { return VkRect2D.create(struct + VkClearRect.RECT); }
/** Unsafe version of {@link #baseArrayLayer}. */
public static int nbaseArrayLayer(long struct) { return memGetInt(struct + VkClearRect.BASEARRAYLAYER); }
/** Unsafe version of {@link #layerCount}. */
public static int nlayerCount(long struct) { return memGetInt(struct + VkClearRect.LAYERCOUNT); }
/** Unsafe version of {@link #rect(VkRect2D) rect}. */
public static void nrect(long struct, VkRect2D value) { memCopy(value.address(), struct + VkClearRect.RECT, VkRect2D.SIZEOF); }
/** Unsafe version of {@link #baseArrayLayer(int) baseArrayLayer}. */
public static void nbaseArrayLayer(long struct, int value) { memPutInt(struct + VkClearRect.BASEARRAYLAYER, value); }
/** Unsafe version of {@link #layerCount(int) layerCount}. */
public static void nlayerCount(long struct, int value) { memPutInt(struct + VkClearRect.LAYERCOUNT, value); }
// -----------------------------------
/** An array of {@link VkClearRect} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkClearRect.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 VkClearRect#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 VkClearRect newInstance(long address) {
return new VkClearRect(address, container);
}
@Override
protected int sizeof() {
return SIZEOF;
}
/** Returns a {@link VkRect2D} view of the {@code rect} field. */
public VkRect2D rect() { return VkClearRect.nrect(address()); }
/** Returns the value of the {@code baseArrayLayer} field. */
public int baseArrayLayer() { return VkClearRect.nbaseArrayLayer(address()); }
/** Returns the value of the {@code layerCount} field. */
public int layerCount() { return VkClearRect.nlayerCount(address()); }
/** Copies the specified {@link VkRect2D} to the {@code rect} field. */
public VkClearRect.Buffer rect(VkRect2D value) { VkClearRect.nrect(address(), value); return this; }
/** Sets the specified value to the {@code baseArrayLayer} field. */
public VkClearRect.Buffer baseArrayLayer(int value) { VkClearRect.nbaseArrayLayer(address(), value); return this; }
/** Sets the specified value to the {@code layerCount} field. */
public VkClearRect.Buffer layerCount(int value) { VkClearRect.nlayerCount(address(), value); return this; }
}
}