org.lwjgl.util.par.ParShapesMesh Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.lwjgl.par Show documentation
LWJGL OSGi bundle (par_shapes bindings)
The newest version!
/*
 * Copyright LWJGL. All rights reserved.
 * License terms: https://www.lwjgl.org/license
 * MACHINE GENERATED FILE, DO NOT EDIT
 */
package org.lwjgl.util.par;

import javax.annotation.*;

import java.nio.*;

import org.lwjgl.system.*;

import static org.lwjgl.system.MemoryUtil.*;

/**
 * The {@code par_shapes.h} mesh structure.
 * 
 * LWJGL note: in the default build, {@code PAR_SHAPES_T} is {@code uint32_t}.
 * 
 * Layout
 * 
 * 
 * struct par_shapes_mesh {
 *     float * {@link #points};
 *     int {@link #npoints};
 *     PAR_SHAPES_T * {@link #triangles};
 *     int {@link #ntriangles};
 *     float * {@link #normals};
 *     float * {@link #tcoords};
 * }
 */
@NativeType("struct par_shapes_mesh")
public class ParShapesMesh extends Struct {

    /** 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
        POINTS,
        NPOINTS,
        TRIANGLES,
        NTRIANGLES,
        NORMALS,
        TCOORDS;

    static {
        Layout layout = __struct(
            __member(POINTER_SIZE),
            __member(4),
            __member(POINTER_SIZE),
            __member(4),
            __member(POINTER_SIZE),
            __member(POINTER_SIZE)
        );

        SIZEOF = layout.getSize();
        ALIGNOF = layout.getAlignment();

        POINTS = layout.offsetof(0);
        NPOINTS = layout.offsetof(1);
        TRIANGLES = layout.offsetof(2);
        NTRIANGLES = layout.offsetof(3);
        NORMALS = layout.offsetof(4);
        TCOORDS = layout.offsetof(5);
    }

    /**
     * Creates a {@code ParShapesMesh} 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 ParShapesMesh(ByteBuffer container) {
        super(memAddress(container), __checkContainer(container, SIZEOF));
    }

    @Override
    public int sizeof() { return SIZEOF; }

    /**
     * @param capacity the number of elements in the returned buffer
     *
     * @return a flat list of 3-tuples (X Y Z X Y Z...) for the vertex positions
     */
    @NativeType("float *")
    public FloatBuffer points(int capacity) { return npoints(address(), capacity); }
    /** the number of points */
    public int npoints() { return nnpoints(address()); }
    /**
     * @param capacity the number of elements in the returned buffer
     *
     * @return flat list of 3-tuples (I J K I J K...)
     */
    @NativeType("PAR_SHAPES_T *")
    public IntBuffer triangles(int capacity) { return ntriangles(address(), capacity); }
    /** the number of triangles */
    public int ntriangles() { return nntriangles(address()); }
    /**
     * @param capacity the number of elements in the returned buffer
     *
     * @return an optional list of 3-tuples (X Y Z X Y Z...) for the vertex normals
     */
    @Nullable
    @NativeType("float *")
    public FloatBuffer normals(int capacity) { return nnormals(address(), capacity); }
    /**
     * @param capacity the number of elements in the returned buffer
     *
     * @return an optional list of 2-tuples (U V U V U V...) for the vertex texture coordinates
     */
    @Nullable
    @NativeType("float *")
    public FloatBuffer tcoords(int capacity) { return ntcoords(address(), capacity); }

    // -----------------------------------

    /** Returns a new {@code ParShapesMesh} instance for the specified memory address. */
    public static ParShapesMesh create(long address) {
        return wrap(ParShapesMesh.class, address);
    }

    /** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
    @Nullable
    public static ParShapesMesh createSafe(long address) {
        return address == NULL ? null : wrap(ParShapesMesh.class, address);
    }

    /**
     * Create a {@link ParShapesMesh.Buffer} instance at the specified memory.
     *
     * @param address  the memory address
     * @param capacity the buffer capacity
     */
    public static ParShapesMesh.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 ParShapesMesh.Buffer createSafe(long address, int capacity) {
        return address == NULL ? null : wrap(Buffer.class, address, capacity);
    }

    // -----------------------------------

    /** Unsafe version of {@link #points(int) points}. */
    public static FloatBuffer npoints(long struct, int capacity) { return memFloatBuffer(memGetAddress(struct + ParShapesMesh.POINTS), capacity); }
    /** Unsafe version of {@link #npoints}. */
    public static int nnpoints(long struct) { return UNSAFE.getInt(null, struct + ParShapesMesh.NPOINTS); }
    /** Unsafe version of {@link #triangles(int) triangles}. */
    public static IntBuffer ntriangles(long struct, int capacity) { return memIntBuffer(memGetAddress(struct + ParShapesMesh.TRIANGLES), capacity); }
    /** Unsafe version of {@link #ntriangles}. */
    public static int nntriangles(long struct) { return UNSAFE.getInt(null, struct + ParShapesMesh.NTRIANGLES); }
    /** Unsafe version of {@link #normals(int) normals}. */
    @Nullable public static FloatBuffer nnormals(long struct, int capacity) { return memFloatBufferSafe(memGetAddress(struct + ParShapesMesh.NORMALS), capacity); }
    /** Unsafe version of {@link #tcoords(int) tcoords}. */
    @Nullable public static FloatBuffer ntcoords(long struct, int capacity) { return memFloatBufferSafe(memGetAddress(struct + ParShapesMesh.TCOORDS), capacity); }

    // -----------------------------------

    /** An array of {@link ParShapesMesh} structs. */
    public static class Buffer extends StructBuffer {

        private static final ParShapesMesh ELEMENT_FACTORY = ParShapesMesh.create(-1L);

        /**
         * Creates a new {@code ParShapesMesh.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 ParShapesMesh#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 ParShapesMesh getElementFactory() {
            return ELEMENT_FACTORY;
        }

        /**
         * @return a {@link FloatBuffer} view of the data pointed to by the {@link ParShapesMesh#points} field.
         *
         * @param capacity the number of elements in the returned buffer
         */
        @NativeType("float *")
        public FloatBuffer points(int capacity) { return ParShapesMesh.npoints(address(), capacity); }
        /** @return the value of the {@link ParShapesMesh#npoints} field. */
        public int npoints() { return ParShapesMesh.nnpoints(address()); }
        /**
         * @return a {@link IntBuffer} view of the data pointed to by the {@link ParShapesMesh#triangles} field.
         *
         * @param capacity the number of elements in the returned buffer
         */
        @NativeType("PAR_SHAPES_T *")
        public IntBuffer triangles(int capacity) { return ParShapesMesh.ntriangles(address(), capacity); }
        /** @return the value of the {@link ParShapesMesh#ntriangles} field. */
        public int ntriangles() { return ParShapesMesh.nntriangles(address()); }
        /**
         * @return a {@link FloatBuffer} view of the data pointed to by the {@link ParShapesMesh#normals} field.
         *
         * @param capacity the number of elements in the returned buffer
         */
        @Nullable
        @NativeType("float *")
        public FloatBuffer normals(int capacity) { return ParShapesMesh.nnormals(address(), capacity); }
        /**
         * @return a {@link FloatBuffer} view of the data pointed to by the {@link ParShapesMesh#tcoords} field.
         *
         * @param capacity the number of elements in the returned buffer
         */
        @Nullable
        @NativeType("float *")
        public FloatBuffer tcoords(int capacity) { return ParShapesMesh.ntcoords(address(), capacity); }

    }

}