org.lwjgl.vulkan.VkVertexInputBindingDivisorDescriptionEXT 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 specifying a divisor used in instanced rendering.
*
* Description
*
* If this structure is not used to define a divisor value for an attribute, then the divisor has a logical default value of 1.
*
* Valid Usage
*
*
* - {@code binding} must be less than {@link VkPhysicalDeviceLimits}{@code ::maxVertexInputBindings}
* - If the {@code vertexAttributeInstanceRateZeroDivisor} feature is not enabled, {@code divisor} must not be 0
* - If the {@code vertexAttributeInstanceRateDivisor} feature is not enabled, {@code divisor} must be 1
* - {@code divisor} must be a value between 0 and {@link VkPhysicalDeviceVertexAttributeDivisorPropertiesEXT}{@code ::maxVertexAttribDivisor}, inclusive
* - {@link VkVertexInputBindingDescription}{@code ::inputRate} must be of type {@link VK10#VK_VERTEX_INPUT_RATE_INSTANCE VERTEX_INPUT_RATE_INSTANCE} for this {@code binding}
*
*
* See Also
*
* {@link VkPipelineVertexInputDivisorStateCreateInfoEXT}
*
* Layout
*
*
* struct VkVertexInputBindingDivisorDescriptionEXT {
* uint32_t {@link #binding};
* uint32_t {@link #divisor};
* }
*/
public class VkVertexInputBindingDivisorDescriptionEXT extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
BINDING,
DIVISOR;
static {
Layout layout = __struct(
__member(4),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
BINDING = layout.offsetof(0);
DIVISOR = layout.offsetof(1);
}
/**
* Creates a {@code VkVertexInputBindingDivisorDescriptionEXT} 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 VkVertexInputBindingDivisorDescriptionEXT(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** the binding number for which the divisor is specified. */
@NativeType("uint32_t")
public int binding() { return nbinding(address()); }
/** the number of successive instances that will use the same value of the vertex attribute when instanced rendering is enabled. For example, if the divisor is N, the same vertex attribute will be applied to N successive instances before moving on to the next vertex attribute. The maximum value of {@code divisor} is implementation-dependent and can be queried using {@link VkPhysicalDeviceVertexAttributeDivisorPropertiesEXT}{@code ::maxVertexAttribDivisor}. A value of 0 can be used for the divisor if the {@code vertexAttributeInstanceRateZeroDivisor} feature is enabled. In this case, the same vertex attribute will be applied to all instances. */
@NativeType("uint32_t")
public int divisor() { return ndivisor(address()); }
/** Sets the specified value to the {@link #binding} field. */
public VkVertexInputBindingDivisorDescriptionEXT binding(@NativeType("uint32_t") int value) { nbinding(address(), value); return this; }
/** Sets the specified value to the {@link #divisor} field. */
public VkVertexInputBindingDivisorDescriptionEXT divisor(@NativeType("uint32_t") int value) { ndivisor(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkVertexInputBindingDivisorDescriptionEXT set(
int binding,
int divisor
) {
binding(binding);
divisor(divisor);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkVertexInputBindingDivisorDescriptionEXT set(VkVertexInputBindingDivisorDescriptionEXT src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code VkVertexInputBindingDivisorDescriptionEXT} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkVertexInputBindingDivisorDescriptionEXT malloc() {
return wrap(VkVertexInputBindingDivisorDescriptionEXT.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code VkVertexInputBindingDivisorDescriptionEXT} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkVertexInputBindingDivisorDescriptionEXT calloc() {
return wrap(VkVertexInputBindingDivisorDescriptionEXT.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code VkVertexInputBindingDivisorDescriptionEXT} instance allocated with {@link BufferUtils}. */
public static VkVertexInputBindingDivisorDescriptionEXT create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(VkVertexInputBindingDivisorDescriptionEXT.class, memAddress(container), container);
}
/** Returns a new {@code VkVertexInputBindingDivisorDescriptionEXT} instance for the specified memory address. */
public static VkVertexInputBindingDivisorDescriptionEXT create(long address) {
return wrap(VkVertexInputBindingDivisorDescriptionEXT.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkVertexInputBindingDivisorDescriptionEXT createSafe(long address) {
return address == NULL ? null : wrap(VkVertexInputBindingDivisorDescriptionEXT.class, address);
}
/**
* Returns a new {@link VkVertexInputBindingDivisorDescriptionEXT.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link VkVertexInputBindingDivisorDescriptionEXT.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkVertexInputBindingDivisorDescriptionEXT.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link VkVertexInputBindingDivisorDescriptionEXT.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer create(long address, int capacity) {
return wrap(Buffer.class, address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
// -----------------------------------
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static VkVertexInputBindingDivisorDescriptionEXT mallocStack() { return malloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static VkVertexInputBindingDivisorDescriptionEXT callocStack() { return calloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static VkVertexInputBindingDivisorDescriptionEXT mallocStack(MemoryStack stack) { return malloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static VkVertexInputBindingDivisorDescriptionEXT callocStack(MemoryStack stack) { return calloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static VkVertexInputBindingDivisorDescriptionEXT.Buffer mallocStack(int capacity) { return malloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static VkVertexInputBindingDivisorDescriptionEXT.Buffer callocStack(int capacity) { return calloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static VkVertexInputBindingDivisorDescriptionEXT.Buffer mallocStack(int capacity, MemoryStack stack) { return malloc(capacity, stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static VkVertexInputBindingDivisorDescriptionEXT.Buffer callocStack(int capacity, MemoryStack stack) { return calloc(capacity, stack); }
/**
* Returns a new {@code VkVertexInputBindingDivisorDescriptionEXT} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkVertexInputBindingDivisorDescriptionEXT malloc(MemoryStack stack) {
return wrap(VkVertexInputBindingDivisorDescriptionEXT.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code VkVertexInputBindingDivisorDescriptionEXT} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkVertexInputBindingDivisorDescriptionEXT calloc(MemoryStack stack) {
return wrap(VkVertexInputBindingDivisorDescriptionEXT.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkVertexInputBindingDivisorDescriptionEXT.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkVertexInputBindingDivisorDescriptionEXT.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 VkVertexInputBindingDivisorDescriptionEXT.Buffer calloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #binding}. */
public static int nbinding(long struct) { return UNSAFE.getInt(null, struct + VkVertexInputBindingDivisorDescriptionEXT.BINDING); }
/** Unsafe version of {@link #divisor}. */
public static int ndivisor(long struct) { return UNSAFE.getInt(null, struct + VkVertexInputBindingDivisorDescriptionEXT.DIVISOR); }
/** Unsafe version of {@link #binding(int) binding}. */
public static void nbinding(long struct, int value) { UNSAFE.putInt(null, struct + VkVertexInputBindingDivisorDescriptionEXT.BINDING, value); }
/** Unsafe version of {@link #divisor(int) divisor}. */
public static void ndivisor(long struct, int value) { UNSAFE.putInt(null, struct + VkVertexInputBindingDivisorDescriptionEXT.DIVISOR, value); }
// -----------------------------------
/** An array of {@link VkVertexInputBindingDivisorDescriptionEXT} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final VkVertexInputBindingDivisorDescriptionEXT ELEMENT_FACTORY = VkVertexInputBindingDivisorDescriptionEXT.create(-1L);
/**
* Creates a new {@code VkVertexInputBindingDivisorDescriptionEXT.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 VkVertexInputBindingDivisorDescriptionEXT#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 VkVertexInputBindingDivisorDescriptionEXT getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link VkVertexInputBindingDivisorDescriptionEXT#binding} field. */
@NativeType("uint32_t")
public int binding() { return VkVertexInputBindingDivisorDescriptionEXT.nbinding(address()); }
/** @return the value of the {@link VkVertexInputBindingDivisorDescriptionEXT#divisor} field. */
@NativeType("uint32_t")
public int divisor() { return VkVertexInputBindingDivisorDescriptionEXT.ndivisor(address()); }
/** Sets the specified value to the {@link VkVertexInputBindingDivisorDescriptionEXT#binding} field. */
public VkVertexInputBindingDivisorDescriptionEXT.Buffer binding(@NativeType("uint32_t") int value) { VkVertexInputBindingDivisorDescriptionEXT.nbinding(address(), value); return this; }
/** Sets the specified value to the {@link VkVertexInputBindingDivisorDescriptionEXT#divisor} field. */
public VkVertexInputBindingDivisorDescriptionEXT.Buffer divisor(@NativeType("uint32_t") int value) { VkVertexInputBindingDivisorDescriptionEXT.ndivisor(address(), value); return this; }
}
}