org.lwjgl.assimp.AIFileIO 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.*;
/**
* Provided are functions to open and close files. Supply a custom structure to the import function. If you don't, a default implementation is used. Use
* custom file systems to enable reading from other sources, such as ZIPs or memory locations.
*
* Member documentation
*
*
* - {@code OpenProc} – Function used to open a new file
* - {@code CloseProc} – Function used to close an existing file
* - {@code UserData} – User-defined, opaque data
*
*
* Layout
*
*
* struct aiFileIO {
* {@link AIFileOpenProcI aiFileOpenProc} OpenProc;
* {@link AIFileCloseProcI aiFileCloseProc} CloseProc;
* aiUserData UserData;
* }
*/
@NativeType("struct aiFileIO")
public class AIFileIO 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
OPENPROC,
CLOSEPROC,
USERDATA;
static {
Layout layout = __struct(
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
OPENPROC = layout.offsetof(0);
CLOSEPROC = layout.offsetof(1);
USERDATA = layout.offsetof(2);
}
/**
* Creates a {@link AIFileIO} 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 AIFileIO(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code OpenProc} field. */
@NativeType("aiFileOpenProc")
public AIFileOpenProc OpenProc() { return nOpenProc(address()); }
/** Returns the value of the {@code CloseProc} field. */
@NativeType("aiFileCloseProc")
public AIFileCloseProc CloseProc() { return nCloseProc(address()); }
/** Returns the value of the {@code UserData} field. */
@NativeType("aiUserData")
public long UserData() { return nUserData(address()); }
/** Sets the specified value to the {@code OpenProc} field. */
public AIFileIO OpenProc(@NativeType("aiFileOpenProc") AIFileOpenProcI value) { nOpenProc(address(), value); return this; }
/** Sets the specified value to the {@code CloseProc} field. */
public AIFileIO CloseProc(@NativeType("aiFileCloseProc") AIFileCloseProcI value) { nCloseProc(address(), value); return this; }
/** Sets the specified value to the {@code UserData} field. */
public AIFileIO UserData(@NativeType("aiUserData") long value) { nUserData(address(), value); return this; }
/** Initializes this struct with the specified values. */
public AIFileIO set(
AIFileOpenProcI OpenProc,
AIFileCloseProcI CloseProc,
long UserData
) {
OpenProc(OpenProc);
CloseProc(CloseProc);
UserData(UserData);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public AIFileIO set(AIFileIO src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link AIFileIO} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static AIFileIO malloc() {
return wrap(AIFileIO.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link AIFileIO} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static AIFileIO calloc() {
return wrap(AIFileIO.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link AIFileIO} instance allocated with {@link BufferUtils}. */
public static AIFileIO create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(AIFileIO.class, memAddress(container), container);
}
/** Returns a new {@link AIFileIO} instance for the specified memory address. */
public static AIFileIO create(long address) {
return wrap(AIFileIO.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static AIFileIO createSafe(long address) {
return address == NULL ? null : wrap(AIFileIO.class, address);
}
/**
* Returns a new {@link AIFileIO.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static AIFileIO.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link AIFileIO.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static AIFileIO.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link AIFileIO.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static AIFileIO.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link AIFileIO.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static AIFileIO.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 AIFileIO.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
// -----------------------------------
/** Returns a new {@link AIFileIO} instance allocated on the thread-local {@link MemoryStack}. */
public static AIFileIO mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link AIFileIO} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static AIFileIO callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link AIFileIO} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static AIFileIO mallocStack(MemoryStack stack) {
return wrap(AIFileIO.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link AIFileIO} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static AIFileIO callocStack(MemoryStack stack) {
return wrap(AIFileIO.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link AIFileIO.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static AIFileIO.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link AIFileIO.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static AIFileIO.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link AIFileIO.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static AIFileIO.Buffer mallocStack(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link AIFileIO.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 AIFileIO.Buffer callocStack(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #OpenProc}. */
public static AIFileOpenProc nOpenProc(long struct) { return AIFileOpenProc.create(memGetAddress(struct + AIFileIO.OPENPROC)); }
/** Unsafe version of {@link #CloseProc}. */
public static AIFileCloseProc nCloseProc(long struct) { return AIFileCloseProc.create(memGetAddress(struct + AIFileIO.CLOSEPROC)); }
/** Unsafe version of {@link #UserData}. */
public static long nUserData(long struct) { return memGetAddress(struct + AIFileIO.USERDATA); }
/** Unsafe version of {@link #OpenProc(AIFileOpenProcI) OpenProc}. */
public static void nOpenProc(long struct, AIFileOpenProcI value) { memPutAddress(struct + AIFileIO.OPENPROC, value.address()); }
/** Unsafe version of {@link #CloseProc(AIFileCloseProcI) CloseProc}. */
public static void nCloseProc(long struct, AIFileCloseProcI value) { memPutAddress(struct + AIFileIO.CLOSEPROC, value.address()); }
/** Unsafe version of {@link #UserData(long) UserData}. */
public static void nUserData(long struct, long value) { memPutAddress(struct + AIFileIO.USERDATA, 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 + AIFileIO.OPENPROC));
check(memGetAddress(struct + AIFileIO.CLOSEPROC));
}
/**
* 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 AIFileIO} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final AIFileIO ELEMENT_FACTORY = AIFileIO.create(-1L);
/**
* Creates a new {@link AIFileIO.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 AIFileIO#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 AIFileIO getElementFactory() {
return ELEMENT_FACTORY;
}
/** Returns the value of the {@code OpenProc} field. */
@NativeType("aiFileOpenProc")
public AIFileOpenProc OpenProc() { return AIFileIO.nOpenProc(address()); }
/** Returns the value of the {@code CloseProc} field. */
@NativeType("aiFileCloseProc")
public AIFileCloseProc CloseProc() { return AIFileIO.nCloseProc(address()); }
/** Returns the value of the {@code UserData} field. */
@NativeType("aiUserData")
public long UserData() { return AIFileIO.nUserData(address()); }
/** Sets the specified value to the {@code OpenProc} field. */
public AIFileIO.Buffer OpenProc(@NativeType("aiFileOpenProc") AIFileOpenProcI value) { AIFileIO.nOpenProc(address(), value); return this; }
/** Sets the specified value to the {@code CloseProc} field. */
public AIFileIO.Buffer CloseProc(@NativeType("aiFileCloseProc") AIFileCloseProcI value) { AIFileIO.nCloseProc(address(), value); return this; }
/** Sets the specified value to the {@code UserData} field. */
public AIFileIO.Buffer UserData(@NativeType("aiUserData") long value) { AIFileIO.nUserData(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy