org.lwjgl.assimp.AIMaterial Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-assimp Show documentation
Show all versions of lwjgl-assimp Show documentation
A portable Open Source library to import various well-known 3D model formats in a uniform manner.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.assimp;
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.*;
/**
* Data structure for a material.
*
* Material data is stored using a key-value structure. A single key-value pair is called a 'material property'. C++ users should use the provided member
* functions of {@code aiMaterial} to process material properties, C users have to stick with the {@code aiMaterialGetXXX} family of unbound functions.
* The library defines a set of standard keys (AI_MATKEY_XXX).
*
* Member documentation
*
*
* - {@code mProperties} – List of all material properties loaded.
* - {@code mNumProperties} – Number of properties in the data base
* - {@code mNumAllocated} – Storage allocated
*
*
* Layout
*
*
* struct aiMaterial {
* {@link AIMaterialProperty struct aiMaterialProperty} ** mProperties;
* unsigned int mNumProperties;
* unsigned int mNumAllocated;
* }
*/
@NativeType("struct aiMaterial")
public class AIMaterial 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
MPROPERTIES,
MNUMPROPERTIES,
MNUMALLOCATED;
static {
Layout layout = __struct(
__member(POINTER_SIZE),
__member(4),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
MPROPERTIES = layout.offsetof(0);
MNUMPROPERTIES = layout.offsetof(1);
MNUMALLOCATED = layout.offsetof(2);
}
/**
* Creates a {@link AIMaterial} 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 AIMaterial(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns a {@link PointerBuffer} view of the data pointed to by the {@code mProperties} field. */
@NativeType("struct aiMaterialProperty **")
public PointerBuffer mProperties() { return nmProperties(address()); }
/** Returns the value of the {@code mNumProperties} field. */
@NativeType("unsigned int")
public int mNumProperties() { return nmNumProperties(address()); }
/** Returns the value of the {@code mNumAllocated} field. */
@NativeType("unsigned int")
public int mNumAllocated() { return nmNumAllocated(address()); }
/** Sets the address of the specified {@link PointerBuffer} to the {@code mProperties} field. */
public AIMaterial mProperties(@NativeType("struct aiMaterialProperty **") PointerBuffer value) { nmProperties(address(), value); return this; }
/** Sets the specified value to the {@code mNumAllocated} field. */
public AIMaterial mNumAllocated(@NativeType("unsigned int") int value) { nmNumAllocated(address(), value); return this; }
/** Initializes this struct with the specified values. */
public AIMaterial set(
PointerBuffer mProperties,
int mNumAllocated
) {
mProperties(mProperties);
mNumAllocated(mNumAllocated);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public AIMaterial set(AIMaterial src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link AIMaterial} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static AIMaterial malloc() {
return wrap(AIMaterial.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link AIMaterial} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static AIMaterial calloc() {
return wrap(AIMaterial.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link AIMaterial} instance allocated with {@link BufferUtils}. */
public static AIMaterial create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(AIMaterial.class, memAddress(container), container);
}
/** Returns a new {@link AIMaterial} instance for the specified memory address. */
public static AIMaterial create(long address) {
return wrap(AIMaterial.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static AIMaterial createSafe(long address) {
return address == NULL ? null : wrap(AIMaterial.class, address);
}
/**
* Returns a new {@link AIMaterial.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static AIMaterial.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link AIMaterial.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static AIMaterial.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link AIMaterial.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static AIMaterial.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link AIMaterial.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static AIMaterial.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 AIMaterial.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
// -----------------------------------
/** Returns a new {@link AIMaterial} instance allocated on the thread-local {@link MemoryStack}. */
public static AIMaterial mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link AIMaterial} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static AIMaterial callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link AIMaterial} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static AIMaterial mallocStack(MemoryStack stack) {
return wrap(AIMaterial.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link AIMaterial} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static AIMaterial callocStack(MemoryStack stack) {
return wrap(AIMaterial.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link AIMaterial.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static AIMaterial.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link AIMaterial.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static AIMaterial.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link AIMaterial.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static AIMaterial.Buffer mallocStack(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link AIMaterial.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 AIMaterial.Buffer callocStack(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #mProperties() mProperties}. */
public static PointerBuffer nmProperties(long struct) { return memPointerBuffer(memGetAddress(struct + AIMaterial.MPROPERTIES), nmNumProperties(struct)); }
/** Unsafe version of {@link #mNumProperties}. */
public static int nmNumProperties(long struct) { return UNSAFE.getInt(null, struct + AIMaterial.MNUMPROPERTIES); }
/** Unsafe version of {@link #mNumAllocated}. */
public static int nmNumAllocated(long struct) { return UNSAFE.getInt(null, struct + AIMaterial.MNUMALLOCATED); }
/** Unsafe version of {@link #mProperties(PointerBuffer) mProperties}. */
public static void nmProperties(long struct, PointerBuffer value) { memPutAddress(struct + AIMaterial.MPROPERTIES, memAddress(value)); nmNumProperties(struct, value.remaining()); }
/** Sets the specified value to the {@code mNumProperties} field of the specified {@code struct}. */
public static void nmNumProperties(long struct, int value) { UNSAFE.putInt(null, struct + AIMaterial.MNUMPROPERTIES, value); }
/** Unsafe version of {@link #mNumAllocated(int) mNumAllocated}. */
public static void nmNumAllocated(long struct, int value) { UNSAFE.putInt(null, struct + AIMaterial.MNUMALLOCATED, value); }
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
check(memGetAddress(struct + AIMaterial.MPROPERTIES));
}
/**
* 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 AIMaterial} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final AIMaterial ELEMENT_FACTORY = AIMaterial.create(-1L);
/**
* Creates a new {@link AIMaterial.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 AIMaterial#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 AIMaterial getElementFactory() {
return ELEMENT_FACTORY;
}
/** Returns a {@link PointerBuffer} view of the data pointed to by the {@code mProperties} field. */
@NativeType("struct aiMaterialProperty **")
public PointerBuffer mProperties() { return AIMaterial.nmProperties(address()); }
/** Returns the value of the {@code mNumProperties} field. */
@NativeType("unsigned int")
public int mNumProperties() { return AIMaterial.nmNumProperties(address()); }
/** Returns the value of the {@code mNumAllocated} field. */
@NativeType("unsigned int")
public int mNumAllocated() { return AIMaterial.nmNumAllocated(address()); }
/** Sets the address of the specified {@link PointerBuffer} to the {@code mProperties} field. */
public AIMaterial.Buffer mProperties(@NativeType("struct aiMaterialProperty **") PointerBuffer value) { AIMaterial.nmProperties(address(), value); return this; }
/** Sets the specified value to the {@code mNumAllocated} field. */
public AIMaterial.Buffer mNumAllocated(@NativeType("unsigned int") int value) { AIMaterial.nmNumAllocated(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy