org.lwjgl.stb.STBTTPackContext Maven / Gradle / Ivy
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.stb;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* An opaque structure which holds all the context needed from {@link STBTruetype#stbtt_PackBegin PackBegin} to {@link STBTruetype#stbtt_PackEnd PackEnd}.
*
* Layout
*
*
* struct stbtt_pack_context {
* void * user_allocator_context;
* {@link STBRPContext stbrp_context} * pack_info;
* int width;
* int height;
* int stride_in_bytes;
* int padding;
* unsigned int h_oversample;
* unsigned int v_oversample;
* unsigned char * pixels;
* {@link STBRPNode stbrp_node} * nodes;
* }The created instance holds a strong reference to the container object.
*/
public STBTTPackContext(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code user_allocator_context} field. */
@NativeType("void *")
public long user_allocator_context() { return nuser_allocator_context(address()); }
/** Returns a {@link STBRPContext} view of the struct pointed to by the {@code pack_info} field. */
@NativeType("stbrp_context *")
public STBRPContext pack_info() { return npack_info(address()); }
/** 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 stride_in_bytes} field. */
public int stride_in_bytes() { return nstride_in_bytes(address()); }
/** Returns the value of the {@code padding} field. */
public int padding() { return npadding(address()); }
/** Returns the value of the {@code h_oversample} field. */
@NativeType("unsigned int")
public int h_oversample() { return nh_oversample(address()); }
/** Returns the value of the {@code v_oversample} field. */
@NativeType("unsigned int")
public int v_oversample() { return nv_oversample(address()); }
/**
* Returns a {@link ByteBuffer} view of the data pointed to by the {@code pixels} field.
*
* @param capacity the number of elements in the returned buffer
*/
@NativeType("unsigned char *")
public ByteBuffer pixels(int capacity) { return npixels(address(), capacity); }
/**
* Returns a {@link STBRPNode.Buffer} view of the struct array pointed to by the {@code nodes} field.
*
* @param capacity the number of elements in the returned buffer
*/
@NativeType("stbrp_node *")
public STBRPNode.Buffer nodes(int capacity) { return nnodes(address(), capacity); }
// -----------------------------------
/** Returns a new {@link STBTTPackContext} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static STBTTPackContext malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link STBTTPackContext} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static STBTTPackContext calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link STBTTPackContext} instance allocated with {@link BufferUtils}. */
public static STBTTPackContext create() {
return new STBTTPackContext(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link STBTTPackContext} instance for the specified memory address. */
public static STBTTPackContext create(long address) {
return new STBTTPackContext(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static STBTTPackContext createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link STBTTPackContext.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static STBTTPackContext.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link STBTTPackContext.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static STBTTPackContext.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link STBTTPackContext.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static STBTTPackContext.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link STBTTPackContext.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static STBTTPackContext.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 STBTTPackContext.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link STBTTPackContext} instance allocated on the thread-local {@link MemoryStack}. */
public static STBTTPackContext mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link STBTTPackContext} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static STBTTPackContext callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link STBTTPackContext} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static STBTTPackContext mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link STBTTPackContext} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static STBTTPackContext callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link STBTTPackContext.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static STBTTPackContext.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link STBTTPackContext.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static STBTTPackContext.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link STBTTPackContext.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static STBTTPackContext.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link STBTTPackContext.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 STBTTPackContext.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #user_allocator_context}. */
public static long nuser_allocator_context(long struct) { return memGetAddress(struct + STBTTPackContext.USER_ALLOCATOR_CONTEXT); }
/** Unsafe version of {@link #pack_info}. */
public static STBRPContext npack_info(long struct) { return STBRPContext.create(memGetAddress(struct + STBTTPackContext.PACK_INFO)); }
/** Unsafe version of {@link #width}. */
public static int nwidth(long struct) { return memGetInt(struct + STBTTPackContext.WIDTH); }
/** Unsafe version of {@link #height}. */
public static int nheight(long struct) { return memGetInt(struct + STBTTPackContext.HEIGHT); }
/** Unsafe version of {@link #stride_in_bytes}. */
public static int nstride_in_bytes(long struct) { return memGetInt(struct + STBTTPackContext.STRIDE_IN_BYTES); }
/** Unsafe version of {@link #padding}. */
public static int npadding(long struct) { return memGetInt(struct + STBTTPackContext.PADDING); }
/** Unsafe version of {@link #h_oversample}. */
public static int nh_oversample(long struct) { return memGetInt(struct + STBTTPackContext.H_OVERSAMPLE); }
/** Unsafe version of {@link #v_oversample}. */
public static int nv_oversample(long struct) { return memGetInt(struct + STBTTPackContext.V_OVERSAMPLE); }
/** Unsafe version of {@link #pixels(int) pixels}. */
public static ByteBuffer npixels(long struct, int capacity) { return memByteBuffer(memGetAddress(struct + STBTTPackContext.PIXELS), capacity); }
/** Unsafe version of {@link #nodes}. */
public static STBRPNode.Buffer nnodes(long struct, int capacity) { return STBRPNode.create(memGetAddress(struct + STBTTPackContext.NODES), capacity); }
// -----------------------------------
/** An array of {@link STBTTPackContext} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link STBTTPackContext.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 STBTTPackContext#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 STBTTPackContext newInstance(long address) {
return new STBTTPackContext(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code user_allocator_context} field. */
@NativeType("void *")
public long user_allocator_context() { return STBTTPackContext.nuser_allocator_context(address()); }
/** Returns a {@link STBRPContext} view of the struct pointed to by the {@code pack_info} field. */
@NativeType("stbrp_context *")
public STBRPContext pack_info() { return STBTTPackContext.npack_info(address()); }
/** Returns the value of the {@code width} field. */
public int width() { return STBTTPackContext.nwidth(address()); }
/** Returns the value of the {@code height} field. */
public int height() { return STBTTPackContext.nheight(address()); }
/** Returns the value of the {@code stride_in_bytes} field. */
public int stride_in_bytes() { return STBTTPackContext.nstride_in_bytes(address()); }
/** Returns the value of the {@code padding} field. */
public int padding() { return STBTTPackContext.npadding(address()); }
/** Returns the value of the {@code h_oversample} field. */
@NativeType("unsigned int")
public int h_oversample() { return STBTTPackContext.nh_oversample(address()); }
/** Returns the value of the {@code v_oversample} field. */
@NativeType("unsigned int")
public int v_oversample() { return STBTTPackContext.nv_oversample(address()); }
/**
* Returns a {@link ByteBuffer} view of the data pointed to by the {@code pixels} field.
*
* @param capacity the number of elements in the returned buffer
*/
@NativeType("unsigned char *")
public ByteBuffer pixels(int capacity) { return STBTTPackContext.npixels(address(), capacity); }
/**
* Returns a {@link STBRPNode.Buffer} view of the struct array pointed to by the {@code nodes} field.
*
* @param capacity the number of elements in the returned buffer
*/
@NativeType("stbrp_node *")
public STBRPNode.Buffer nodes(int capacity) { return STBTTPackContext.nnodes(address(), capacity); }
}
}