com.labymedia.ultralight.plugin.render.UltralightVertexBuffer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ultralight-java-base Show documentation

Ultralight bindings for Java

There is a newer version: 0.4.12

/*
 * Ultralight Java - Java wrapper for the Ultralight web engine
 * Copyright (C) 2020 - 2021 LabyMedia and contributors
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

package com.labymedia.ultralight.plugin.render;

import com.labymedia.ultralight.annotation.NativeCall;
import com.labymedia.ultralight.annotation.NativeType;

import java.nio.ByteBuffer;

/**
 * Vertex buffer.
 *
 * @see UltralightGPUDriver#createGeometry(long, UltralightVertexBuffer, UltralightIndexBuffer)
 */
@NativeType("ultralight::VertexBuffer")
public class UltralightVertexBuffer {
    private final UltralightVertexBufferFormat format;
    private final @NativeType("uint8_t[]")
    ByteBuffer data;

    /**
     * Constructs a new {@link UltralightVertexBuffer} wrapping an existing native buffer.
     *
     * @param format The format of the buffer
     * @param data   The data to wrap of the buffer
     */
    @NativeCall
    public UltralightVertexBuffer(UltralightVertexBufferFormat format, @NativeType("uint8_t[]") ByteBuffer data) {
        this.format = format;
        this.data = data;
    }

    /**
     * Retrieves the format of the the buffer.
     *
     * @return The format of the buffer
     */
    public UltralightVertexBufferFormat getFormat() {
        return format;
    }

    /**
     * Retrieves the data of the buffer.
     *
     * @return The data of the buffer
     */
    public ByteBuffer getData() {
        return data;
    }
}