org.lwjgl.vulkan.VkVertexInputAttributeDescription 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 vertex input attribute description.
*
* Valid Usage
*
*
* - {@code location} must be less than {@link VkPhysicalDeviceLimits}{@code ::maxVertexInputAttributes}
* - {@code binding} must be less than {@link VkPhysicalDeviceLimits}{@code ::maxVertexInputBindings}
* - {@code offset} must be less than or equal to {@link VkPhysicalDeviceLimits}{@code ::maxVertexInputAttributeOffset}
* - {@code format} must be allowed as a vertex buffer format, as specified by the {@link VK10#VK_FORMAT_FEATURE_VERTEX_BUFFER_BIT FORMAT_FEATURE_VERTEX_BUFFER_BIT} flag in {@link VkFormatProperties}{@code ::bufferFeatures} returned by {@code vkGetPhysicalDeviceFormatProperties}
* - If the {@link KHRPortabilitySubset VK_KHR_portability_subset} extension is enabled, and {@link VkPhysicalDevicePortabilitySubsetFeaturesKHR}{@code ::vertexAttributeAccessBeyondStride} is {@link VK10#VK_FALSE FALSE}, the sum of {@code offset} plus the size of the vertex attribute data described by {@code format} must not be greater than {@code stride} in the {@link VkVertexInputBindingDescription} referenced in {@code binding}
*
*
* Valid Usage (Implicit)
*
*
* - {@code format} must be a valid {@code VkFormat} value
*
*
* See Also
*
* {@link VkPipelineVertexInputStateCreateInfo}
*
* Layout
*
*
* struct VkVertexInputAttributeDescription {
* uint32_t {@link #location};
* uint32_t {@link #binding};
* VkFormat {@link #format};
* uint32_t {@link #offset};
* }
*/
public class VkVertexInputAttributeDescription 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
LOCATION,
BINDING,
FORMAT,
OFFSET;
static {
Layout layout = __struct(
__member(4),
__member(4),
__member(4),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
LOCATION = layout.offsetof(0);
BINDING = layout.offsetof(1);
FORMAT = layout.offsetof(2);
OFFSET = layout.offsetof(3);
}
/**
* Creates a {@code VkVertexInputAttributeDescription} 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 VkVertexInputAttributeDescription(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** the shader input location number for this attribute. */
@NativeType("uint32_t")
public int location() { return nlocation(address()); }
/** the binding number which this attribute takes its data from. */
@NativeType("uint32_t")
public int binding() { return nbinding(address()); }
/** the size and type of the vertex attribute data. */
@NativeType("VkFormat")
public int format() { return nformat(address()); }
/** a byte offset of this attribute relative to the start of an element in the vertex input binding. */
@NativeType("uint32_t")
public int offset() { return noffset(address()); }
/** Sets the specified value to the {@link #location} field. */
public VkVertexInputAttributeDescription location(@NativeType("uint32_t") int value) { nlocation(address(), value); return this; }
/** Sets the specified value to the {@link #binding} field. */
public VkVertexInputAttributeDescription binding(@NativeType("uint32_t") int value) { nbinding(address(), value); return this; }
/** Sets the specified value to the {@link #format} field. */
public VkVertexInputAttributeDescription format(@NativeType("VkFormat") int value) { nformat(address(), value); return this; }
/** Sets the specified value to the {@link #offset} field. */
public VkVertexInputAttributeDescription offset(@NativeType("uint32_t") int value) { noffset(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkVertexInputAttributeDescription set(
int location,
int binding,
int format,
int offset
) {
location(location);
binding(binding);
format(format);
offset(offset);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkVertexInputAttributeDescription set(VkVertexInputAttributeDescription src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code VkVertexInputAttributeDescription} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkVertexInputAttributeDescription malloc() {
return wrap(VkVertexInputAttributeDescription.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code VkVertexInputAttributeDescription} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkVertexInputAttributeDescription calloc() {
return wrap(VkVertexInputAttributeDescription.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code VkVertexInputAttributeDescription} instance allocated with {@link BufferUtils}. */
public static VkVertexInputAttributeDescription create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(VkVertexInputAttributeDescription.class, memAddress(container), container);
}
/** Returns a new {@code VkVertexInputAttributeDescription} instance for the specified memory address. */
public static VkVertexInputAttributeDescription create(long address) {
return wrap(VkVertexInputAttributeDescription.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkVertexInputAttributeDescription createSafe(long address) {
return address == NULL ? null : wrap(VkVertexInputAttributeDescription.class, address);
}
/**
* Returns a new {@link VkVertexInputAttributeDescription.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkVertexInputAttributeDescription.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link VkVertexInputAttributeDescription.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkVertexInputAttributeDescription.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkVertexInputAttributeDescription.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkVertexInputAttributeDescription.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link VkVertexInputAttributeDescription.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkVertexInputAttributeDescription.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 VkVertexInputAttributeDescription.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 VkVertexInputAttributeDescription mallocStack() { return malloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static VkVertexInputAttributeDescription callocStack() { return calloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static VkVertexInputAttributeDescription mallocStack(MemoryStack stack) { return malloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static VkVertexInputAttributeDescription callocStack(MemoryStack stack) { return calloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static VkVertexInputAttributeDescription.Buffer mallocStack(int capacity) { return malloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static VkVertexInputAttributeDescription.Buffer callocStack(int capacity) { return calloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static VkVertexInputAttributeDescription.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 VkVertexInputAttributeDescription.Buffer callocStack(int capacity, MemoryStack stack) { return calloc(capacity, stack); }
/**
* Returns a new {@code VkVertexInputAttributeDescription} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkVertexInputAttributeDescription malloc(MemoryStack stack) {
return wrap(VkVertexInputAttributeDescription.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code VkVertexInputAttributeDescription} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkVertexInputAttributeDescription calloc(MemoryStack stack) {
return wrap(VkVertexInputAttributeDescription.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkVertexInputAttributeDescription.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkVertexInputAttributeDescription.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkVertexInputAttributeDescription.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 VkVertexInputAttributeDescription.Buffer calloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #location}. */
public static int nlocation(long struct) { return UNSAFE.getInt(null, struct + VkVertexInputAttributeDescription.LOCATION); }
/** Unsafe version of {@link #binding}. */
public static int nbinding(long struct) { return UNSAFE.getInt(null, struct + VkVertexInputAttributeDescription.BINDING); }
/** Unsafe version of {@link #format}. */
public static int nformat(long struct) { return UNSAFE.getInt(null, struct + VkVertexInputAttributeDescription.FORMAT); }
/** Unsafe version of {@link #offset}. */
public static int noffset(long struct) { return UNSAFE.getInt(null, struct + VkVertexInputAttributeDescription.OFFSET); }
/** Unsafe version of {@link #location(int) location}. */
public static void nlocation(long struct, int value) { UNSAFE.putInt(null, struct + VkVertexInputAttributeDescription.LOCATION, value); }
/** Unsafe version of {@link #binding(int) binding}. */
public static void nbinding(long struct, int value) { UNSAFE.putInt(null, struct + VkVertexInputAttributeDescription.BINDING, value); }
/** Unsafe version of {@link #format(int) format}. */
public static void nformat(long struct, int value) { UNSAFE.putInt(null, struct + VkVertexInputAttributeDescription.FORMAT, value); }
/** Unsafe version of {@link #offset(int) offset}. */
public static void noffset(long struct, int value) { UNSAFE.putInt(null, struct + VkVertexInputAttributeDescription.OFFSET, value); }
// -----------------------------------
/** An array of {@link VkVertexInputAttributeDescription} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final VkVertexInputAttributeDescription ELEMENT_FACTORY = VkVertexInputAttributeDescription.create(-1L);
/**
* Creates a new {@code VkVertexInputAttributeDescription.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 VkVertexInputAttributeDescription#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 VkVertexInputAttributeDescription getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link VkVertexInputAttributeDescription#location} field. */
@NativeType("uint32_t")
public int location() { return VkVertexInputAttributeDescription.nlocation(address()); }
/** @return the value of the {@link VkVertexInputAttributeDescription#binding} field. */
@NativeType("uint32_t")
public int binding() { return VkVertexInputAttributeDescription.nbinding(address()); }
/** @return the value of the {@link VkVertexInputAttributeDescription#format} field. */
@NativeType("VkFormat")
public int format() { return VkVertexInputAttributeDescription.nformat(address()); }
/** @return the value of the {@link VkVertexInputAttributeDescription#offset} field. */
@NativeType("uint32_t")
public int offset() { return VkVertexInputAttributeDescription.noffset(address()); }
/** Sets the specified value to the {@link VkVertexInputAttributeDescription#location} field. */
public VkVertexInputAttributeDescription.Buffer location(@NativeType("uint32_t") int value) { VkVertexInputAttributeDescription.nlocation(address(), value); return this; }
/** Sets the specified value to the {@link VkVertexInputAttributeDescription#binding} field. */
public VkVertexInputAttributeDescription.Buffer binding(@NativeType("uint32_t") int value) { VkVertexInputAttributeDescription.nbinding(address(), value); return this; }
/** Sets the specified value to the {@link VkVertexInputAttributeDescription#format} field. */
public VkVertexInputAttributeDescription.Buffer format(@NativeType("VkFormat") int value) { VkVertexInputAttributeDescription.nformat(address(), value); return this; }
/** Sets the specified value to the {@link VkVertexInputAttributeDescription#offset} field. */
public VkVertexInputAttributeDescription.Buffer offset(@NativeType("uint32_t") int value) { VkVertexInputAttributeDescription.noffset(address(), value); return this; }
}
}