org.lwjgl.nanovg.NVGLUFramebuffer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-nanovg Show documentation
A small antialiased vector graphics rendering library for OpenGL. Also includes NanoSVG, a simple SVG parser.
There is a newer version: 3.3.4
/*
 * Copyright LWJGL. All rights reserved.
 * License terms: https://www.lwjgl.org/license
 * MACHINE GENERATED FILE, DO NOT EDIT
 */
package org.lwjgl.nanovg;

import javax.annotation.*;

import java.nio.*;

import org.lwjgl.system.*;

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

/**
 * A framebuffer object.
 * 
 * Member documentation
 * 
 * 
 * {@code fbo} – the OpenGL framebuffer object handle
 * {@code rbo} – the OpenGL renderbuffer handle
 * {@code texture} – the OpenGL texture handle
 * {@code image} – the NanoVG image handle
 * 
 * 
 * Layout
 * 
 *  * struct NVGLUframebuffer {
 *     GLuint fbo;
 *     GLuint rbo;
 *     GLuint texture;
 *     int image;
 * }
 */
@NativeType("struct NVGLUframebuffer")
public class NVGLUFramebuffer extends Struct {

    /** The struct size in bytes. */
    public static final int SIZEOF;

    public static final int ALIGNOF;

    /** The struct member offsets. */
    public static final int
        FBO,
        RBO,
        TEXTURE,
        IMAGE;

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

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

        FBO = layout.offsetof(0);
        RBO = layout.offsetof(1);
        TEXTURE = layout.offsetof(2);
        IMAGE = layout.offsetof(3);
    }

    NVGLUFramebuffer(long address, @Nullable ByteBuffer container) {
        super(address, container);
    }

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

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

    /** Returns the value of the {@code fbo} field. */
    @NativeType("GLuint")
    public int fbo() { return nfbo(address()); }
    /** Returns the value of the {@code rbo} field. */
    @NativeType("GLuint")
    public int rbo() { return nrbo(address()); }
    /** Returns the value of the {@code texture} field. */
    @NativeType("GLuint")
    public int texture() { return ntexture(address()); }
    /** Returns the value of the {@code image} field. */
    public int image() { return nimage(address()); }

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

    /** Returns a new {@link NVGLUFramebuffer} instance for the specified memory address. */
    public static NVGLUFramebuffer create(long address) {
        return new NVGLUFramebuffer(address, null);
    }

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

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

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

    /** Unsafe version of {@link #fbo}. */
    public static int nfbo(long struct) { return memGetInt(struct + NVGLUFramebuffer.FBO); }
    /** Unsafe version of {@link #rbo}. */
    public static int nrbo(long struct) { return memGetInt(struct + NVGLUFramebuffer.RBO); }
    /** Unsafe version of {@link #texture}. */
    public static int ntexture(long struct) { return memGetInt(struct + NVGLUFramebuffer.TEXTURE); }
    /** Unsafe version of {@link #image}. */
    public static int nimage(long struct) { return memGetInt(struct + NVGLUFramebuffer.IMAGE); }

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

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

        /**
         * Creates a new {@link NVGLUFramebuffer.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 NVGLUFramebuffer#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 NVGLUFramebuffer newInstance(long address) {
            return new NVGLUFramebuffer(address, container);
        }

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

        /** Returns the value of the {@code fbo} field. */
        @NativeType("GLuint")
        public int fbo() { return NVGLUFramebuffer.nfbo(address()); }
        /** Returns the value of the {@code rbo} field. */
        @NativeType("GLuint")
        public int rbo() { return NVGLUFramebuffer.nrbo(address()); }
        /** Returns the value of the {@code texture} field. */
        @NativeType("GLuint")
        public int texture() { return NVGLUFramebuffer.ntexture(address()); }
        /** Returns the value of the {@code image} field. */
        public int image() { return NVGLUFramebuffer.nimage(address()); }

    }

}