org.lwjgl.glfw.GLFWVidMode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-glfw Show documentation
A multi-platform library for OpenGL, OpenGL ES and Vulkan development on the desktop. It provides a simple API for creating windows, contexts and surfaces, receiving input and events.
There is a newer version: 3.3.4
Show newest version
/*
 * Copyright LWJGL. All rights reserved.
 * License terms: https://www.lwjgl.org/license
 * MACHINE GENERATED FILE, DO NOT EDIT
 */
package org.lwjgl.glfw;

import java.nio.*;

import org.lwjgl.system.*;

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

/**
 * Describes a single video mode.
 * 
 * Member documentation
 * 
 * 
 * {@code width} – the width, in screen coordinates, of the video mode
 * {@code height} – the height, in screen coordinates, of the video mode
 * {@code redBits} – the bit depth of the red channel of the video mode
 * {@code greenBits} – the bit depth of the green channel of the video mode
 * {@code blueBits} – the bit depth of the blue channel of the video mode
 * {@code refreshRate} – the refresh rate, in Hz, of the video mode
 * 
 * 
 * Layout
 * 
 * struct GLFWvidmode {
    int width;
    int height;
    int redBits;
    int greenBits;
    int blueBits;
    int refreshRate;
}
 */
public class GLFWVidMode 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
		WIDTH,
		HEIGHT,
		REDBITS,
		GREENBITS,
		BLUEBITS,
		REFRESHRATE;

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

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

		WIDTH = layout.offsetof(0);
		HEIGHT = layout.offsetof(1);
		REDBITS = layout.offsetof(2);
		GREENBITS = layout.offsetof(3);
		BLUEBITS = layout.offsetof(4);
		REFRESHRATE = layout.offsetof(5);
	}

	GLFWVidMode(long address, ByteBuffer container) {
		super(address, container);
	}

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

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

	/** Returns the value of the {@code width} field. */
	public int width() { return nwidth(address()); }
	/** Returns the value of the {@code height} field. */
	public int height() { return nheight(address()); }
	/** Returns the value of the {@code redBits} field. */
	public int redBits() { return nredBits(address()); }
	/** Returns the value of the {@code greenBits} field. */
	public int greenBits() { return ngreenBits(address()); }
	/** Returns the value of the {@code blueBits} field. */
	public int blueBits() { return nblueBits(address()); }
	/** Returns the value of the {@code refreshRate} field. */
	public int refreshRate() { return nrefreshRate(address()); }

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

	/** Returns a new {@link GLFWVidMode} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
	public static GLFWVidMode create(long address) {
		return address == NULL ? null : new GLFWVidMode(address, null);
	}

	/**
	 * Create a {@link GLFWVidMode.Buffer} instance at the specified memory.
	 *
	 * @param address  the memory address
	 * @param capacity the buffer capacity
	 */
	public static Buffer create(long address, int capacity) {
		return address == NULL ? null : new Buffer(address, null, -1, 0, capacity, capacity);
	}

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

	/** Unsafe version of {@link #width}. */
	public static int nwidth(long struct) { return memGetInt(struct + GLFWVidMode.WIDTH); }
	/** Unsafe version of {@link #height}. */
	public static int nheight(long struct) { return memGetInt(struct + GLFWVidMode.HEIGHT); }
	/** Unsafe version of {@link #redBits}. */
	public static int nredBits(long struct) { return memGetInt(struct + GLFWVidMode.REDBITS); }
	/** Unsafe version of {@link #greenBits}. */
	public static int ngreenBits(long struct) { return memGetInt(struct + GLFWVidMode.GREENBITS); }
	/** Unsafe version of {@link #blueBits}. */
	public static int nblueBits(long struct) { return memGetInt(struct + GLFWVidMode.BLUEBITS); }
	/** Unsafe version of {@link #refreshRate}. */
	public static int nrefreshRate(long struct) { return memGetInt(struct + GLFWVidMode.REFRESHRATE); }

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

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

		/**
		 * Creates a new {@link GLFWVidMode.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 GLFWVidMode#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);
		}

		Buffer(long address, 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, ByteBuffer container, int mark, int pos, int lim, int cap) {
			return new Buffer(address, container, mark, pos, lim, cap);
		}

		@Override
		protected GLFWVidMode newInstance(long address) {
			return new GLFWVidMode(address, container);
		}

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

		/** Returns the value of the {@code width} field. */
		public int width() { return GLFWVidMode.nwidth(address()); }
		/** Returns the value of the {@code height} field. */
		public int height() { return GLFWVidMode.nheight(address()); }
		/** Returns the value of the {@code redBits} field. */
		public int redBits() { return GLFWVidMode.nredBits(address()); }
		/** Returns the value of the {@code greenBits} field. */
		public int greenBits() { return GLFWVidMode.ngreenBits(address()); }
		/** Returns the value of the {@code blueBits} field. */
		public int blueBits() { return GLFWVidMode.nblueBits(address()); }
		/** Returns the value of the {@code refreshRate} field. */
		public int refreshRate() { return GLFWVidMode.nrefreshRate(address()); }

	}

}