org.lwjgl.bgfx.BGFXVertexDecl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-bgfx Show documentation
Show all versions of lwjgl-bgfx Show documentation
A cross-platform, graphics API agnostic rendering library. It provides a high performance, low level abstraction for common platform graphics APIs like OpenGL, Direct3D and Apple Metal.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.bgfx;
import javax.annotation.*;
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.*;
import static org.lwjgl.bgfx.BGFX.BGFX_ATTRIB_COUNT;
/**
* Vertex declaration.
*
* Member documentation
*
*
* - {@code stride} – vertex stride
* - {@code offset} – relative attribute offset from the vertex
*
*
* Layout
*
*
* struct bgfx_vertex_decl_t {
* uint32_t hash;
* uint16_t stride;
* uint16_t offset[BGFX_ATTRIB_COUNT];
* uint16_t attributes[BGFX_ATTRIB_COUNT];
* }The created instance holds a strong reference to the container object.
*/
public BGFXVertexDecl(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code hash} field. */
@NativeType("uint32_t")
public int hash() { return nhash(address()); }
/** Returns the value of the {@code stride} field. */
@NativeType("uint16_t")
public short stride() { return nstride(address()); }
/** Returns a {@link ShortBuffer} view of the {@code offset} field. */
@NativeType("uint16_t[BGFX_ATTRIB_COUNT]")
public ShortBuffer offset() { return noffset(address()); }
/** Returns the value at the specified index of the {@code offset} field. */
@NativeType("uint16_t")
public short offset(int index) { return noffset(address(), index); }
/** Returns a {@link ShortBuffer} view of the {@code attributes} field. */
@NativeType("uint16_t[BGFX_ATTRIB_COUNT]")
public ShortBuffer attributes() { return nattributes(address()); }
/** Returns the value at the specified index of the {@code attributes} field. */
@NativeType("uint16_t")
public short attributes(int index) { return nattributes(address(), index); }
/** Sets the specified value to the {@code hash} field. */
public BGFXVertexDecl hash(@NativeType("uint32_t") int value) { nhash(address(), value); return this; }
/** Sets the specified value to the {@code stride} field. */
public BGFXVertexDecl stride(@NativeType("uint16_t") short value) { nstride(address(), value); return this; }
/** Copies the specified {@link ShortBuffer} to the {@code offset} field. */
public BGFXVertexDecl offset(@NativeType("uint16_t[BGFX_ATTRIB_COUNT]") ShortBuffer value) { noffset(address(), value); return this; }
/** Sets the specified value at the specified index of the {@code offset} field. */
public BGFXVertexDecl offset(int index, @NativeType("uint16_t") short value) { noffset(address(), index, value); return this; }
/** Copies the specified {@link ShortBuffer} to the {@code attributes} field. */
public BGFXVertexDecl attributes(@NativeType("uint16_t[BGFX_ATTRIB_COUNT]") ShortBuffer value) { nattributes(address(), value); return this; }
/** Sets the specified value at the specified index of the {@code attributes} field. */
public BGFXVertexDecl attributes(int index, @NativeType("uint16_t") short value) { nattributes(address(), index, value); return this; }
/** Initializes this struct with the specified values. */
public BGFXVertexDecl set(
int hash,
short stride,
ShortBuffer offset,
ShortBuffer attributes
) {
hash(hash);
stride(stride);
offset(offset);
attributes(attributes);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public BGFXVertexDecl set(BGFXVertexDecl src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link BGFXVertexDecl} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static BGFXVertexDecl malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link BGFXVertexDecl} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static BGFXVertexDecl calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link BGFXVertexDecl} instance allocated with {@link BufferUtils}. */
public static BGFXVertexDecl create() {
return new BGFXVertexDecl(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link BGFXVertexDecl} instance for the specified memory address. */
public static BGFXVertexDecl create(long address) {
return new BGFXVertexDecl(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static BGFXVertexDecl createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link BGFXVertexDecl.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static BGFXVertexDecl.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link BGFXVertexDecl.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static BGFXVertexDecl.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link BGFXVertexDecl.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static BGFXVertexDecl.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link BGFXVertexDecl.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static BGFXVertexDecl.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static BGFXVertexDecl.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link BGFXVertexDecl} instance allocated on the thread-local {@link MemoryStack}. */
public static BGFXVertexDecl mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link BGFXVertexDecl} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static BGFXVertexDecl callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link BGFXVertexDecl} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static BGFXVertexDecl mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link BGFXVertexDecl} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static BGFXVertexDecl callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link BGFXVertexDecl.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static BGFXVertexDecl.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link BGFXVertexDecl.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static BGFXVertexDecl.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link BGFXVertexDecl.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static BGFXVertexDecl.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link BGFXVertexDecl.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 BGFXVertexDecl.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #hash}. */
public static int nhash(long struct) { return memGetInt(struct + BGFXVertexDecl.HASH); }
/** Unsafe version of {@link #stride}. */
public static short nstride(long struct) { return memGetShort(struct + BGFXVertexDecl.STRIDE); }
/** Unsafe version of {@link #offset}. */
public static ShortBuffer noffset(long struct) { return memShortBuffer(struct + BGFXVertexDecl.OFFSET, BGFX_ATTRIB_COUNT); }
/** Unsafe version of {@link #offset(int) offset}. */
public static short noffset(long struct, int index) {
if (CHECKS) { check(index, BGFX_ATTRIB_COUNT); }
return memGetShort(struct + BGFXVertexDecl.OFFSET + index * 2);
}
/** Unsafe version of {@link #attributes}. */
public static ShortBuffer nattributes(long struct) { return memShortBuffer(struct + BGFXVertexDecl.ATTRIBUTES, BGFX_ATTRIB_COUNT); }
/** Unsafe version of {@link #attributes(int) attributes}. */
public static short nattributes(long struct, int index) {
if (CHECKS) { check(index, BGFX_ATTRIB_COUNT); }
return memGetShort(struct + BGFXVertexDecl.ATTRIBUTES + index * 2);
}
/** Unsafe version of {@link #hash(int) hash}. */
public static void nhash(long struct, int value) { memPutInt(struct + BGFXVertexDecl.HASH, value); }
/** Unsafe version of {@link #stride(short) stride}. */
public static void nstride(long struct, short value) { memPutShort(struct + BGFXVertexDecl.STRIDE, value); }
/** Unsafe version of {@link #offset(ShortBuffer) offset}. */
public static void noffset(long struct, ShortBuffer value) {
if (CHECKS) { checkGT(value, BGFX_ATTRIB_COUNT); }
memCopy(memAddress(value), struct + BGFXVertexDecl.OFFSET, value.remaining() * 2);
}
/** Unsafe version of {@link #offset(int, short) offset}. */
public static void noffset(long struct, int index, short value) {
if (CHECKS) { check(index, BGFX_ATTRIB_COUNT); }
memPutShort(struct + BGFXVertexDecl.OFFSET + index * 2, value);
}
/** Unsafe version of {@link #attributes(ShortBuffer) attributes}. */
public static void nattributes(long struct, ShortBuffer value) {
if (CHECKS) { checkGT(value, BGFX_ATTRIB_COUNT); }
memCopy(memAddress(value), struct + BGFXVertexDecl.ATTRIBUTES, value.remaining() * 2);
}
/** Unsafe version of {@link #attributes(int, short) attributes}. */
public static void nattributes(long struct, int index, short value) {
if (CHECKS) { check(index, BGFX_ATTRIB_COUNT); }
memPutShort(struct + BGFXVertexDecl.ATTRIBUTES + index * 2, value);
}
// -----------------------------------
/** An array of {@link BGFXVertexDecl} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link BGFXVertexDecl.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 BGFXVertexDecl#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 Buffer newBufferInstance(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected BGFXVertexDecl newInstance(long address) {
return new BGFXVertexDecl(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code hash} field. */
@NativeType("uint32_t")
public int hash() { return BGFXVertexDecl.nhash(address()); }
/** Returns the value of the {@code stride} field. */
@NativeType("uint16_t")
public short stride() { return BGFXVertexDecl.nstride(address()); }
/** Returns a {@link ShortBuffer} view of the {@code offset} field. */
@NativeType("uint16_t[BGFX_ATTRIB_COUNT]")
public ShortBuffer offset() { return BGFXVertexDecl.noffset(address()); }
/** Returns the value at the specified index of the {@code offset} field. */
@NativeType("uint16_t")
public short offset(int index) { return BGFXVertexDecl.noffset(address(), index); }
/** Returns a {@link ShortBuffer} view of the {@code attributes} field. */
@NativeType("uint16_t[BGFX_ATTRIB_COUNT]")
public ShortBuffer attributes() { return BGFXVertexDecl.nattributes(address()); }
/** Returns the value at the specified index of the {@code attributes} field. */
@NativeType("uint16_t")
public short attributes(int index) { return BGFXVertexDecl.nattributes(address(), index); }
/** Sets the specified value to the {@code hash} field. */
public BGFXVertexDecl.Buffer hash(@NativeType("uint32_t") int value) { BGFXVertexDecl.nhash(address(), value); return this; }
/** Sets the specified value to the {@code stride} field. */
public BGFXVertexDecl.Buffer stride(@NativeType("uint16_t") short value) { BGFXVertexDecl.nstride(address(), value); return this; }
/** Copies the specified {@link ShortBuffer} to the {@code offset} field. */
public BGFXVertexDecl.Buffer offset(@NativeType("uint16_t[BGFX_ATTRIB_COUNT]") ShortBuffer value) { BGFXVertexDecl.noffset(address(), value); return this; }
/** Sets the specified value at the specified index of the {@code offset} field. */
public BGFXVertexDecl.Buffer offset(int index, @NativeType("uint16_t") short value) { BGFXVertexDecl.noffset(address(), index, value); return this; }
/** Copies the specified {@link ShortBuffer} to the {@code attributes} field. */
public BGFXVertexDecl.Buffer attributes(@NativeType("uint16_t[BGFX_ATTRIB_COUNT]") ShortBuffer value) { BGFXVertexDecl.nattributes(address(), value); return this; }
/** Sets the specified value at the specified index of the {@code attributes} field. */
public BGFXVertexDecl.Buffer attributes(int index, @NativeType("uint16_t") short value) { BGFXVertexDecl.nattributes(address(), index, value); return this; }
}
}