org.lwjgl.stb.STBRectPack 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 org.lwjgl.system.*;
/**
* Native bindings to stb_rect_pack.h from the stb library.
*
* Useful for e.g. packing rectangular textures into an atlas. Does not do rotation.
*
* This library currently uses the Skyline Bottom-Left algorithm. Not necessarily the awesomest packing method, but better than the totally naive one in
* stb_truetype (which is primarily what this is meant to replace).
*/
public class STBRectPack {
static { LibSTB.initialize(); }
/** Mostly for internal use, but this is the maximum supported coordinate value. */
public static final int STBRP__MAXVAL = 0x7FFFFFFF;
/**
* Packing heuristics
*
* Enum values:
*
*
* - {@link #STBRP_HEURISTIC_Skyline_default HEURISTIC_Skyline_default}
* - {@link #STBRP_HEURISTIC_Skyline_BL_sortHeight HEURISTIC_Skyline_BL_sortHeight}
* - {@link #STBRP_HEURISTIC_Skyline_BF_sortHeight HEURISTIC_Skyline_BF_sortHeight}
*
*/
public static final int
STBRP_HEURISTIC_Skyline_default = 0,
STBRP_HEURISTIC_Skyline_BL_sortHeight = STBRP_HEURISTIC_Skyline_default,
STBRP_HEURISTIC_Skyline_BF_sortHeight = 1;
protected STBRectPack() {
throw new UnsupportedOperationException();
}
// --- [ stbrp_pack_rects ] ---
/**
* Unsafe version of: {@link #stbrp_pack_rects pack_rects}
*
* @param num_rects the number of structs in {@code rects}
*/
public static native int nstbrp_pack_rects(long context, long rects, int num_rects);
/**
* Assigns packed locations to rectangles. The rectangles are of type {@link STBRPRect}, stored in the array {@code rects}, and there are {@code num_rects} many
* of them.
*
* Rectangles which are successfully packed have the {@code was_packed} flag set to a non-zero value and {@code x} and {@code y} store the minimum
* location on each axis (i.e. bottom-left in cartesian coordinates, top-left if you imagine y increasing downwards). Rectangles which do not fit have the
* {@code was_packed} flag set to 0.
*
* You should not try to access the {@code rects} array from another thread while this function is running, as the function temporarily reorders the array
* while it executes.
*
* To pack into another rectangle, you need to call {@link #stbrp_init_target init_target} again. To continue packing into the same rectangle, you can call this function again.
* Calling this multiple times with multiple rect arrays will probably produce worse packing results than calling it a single time with the full rectangle
* array, but the option is available.
*
* @param context an {@link STBRPContext} struct
* @param rects an array of {@link STBRPRect} structs
*
* @return 1 if all of the rectangles were successfully packed and 0 otherwise
*/
public static int stbrp_pack_rects(@NativeType("stbrp_context *") STBRPContext context, @NativeType("stbrp_rect *") STBRPRect.Buffer rects) {
return nstbrp_pack_rects(context.address(), rects.address(), rects.remaining());
}
// --- [ stbrp_init_target ] ---
/**
* Unsafe version of: {@link #stbrp_init_target init_target}
*
* @param num_nodes the number of structs in {@code nodes}
*/
public static native void nstbrp_init_target(long context, int width, int height, long nodes, int num_nodes);
/**
* Initialize a rectangle packer to: pack a rectangle that is {@code width} by {@code height} in dimensions using temporary storage provided by the array
* {@code nodes}, which is {@code num_nodes} long.
*
* You must call this function every time you start packing into a new target.
*
* There is no "shutdown" function. The {@code nodes} memory must stay valid for the following {@link #stbrp_pack_rects pack_rects} call (or calls), but can be freed after the
* call (or calls) finish.
*
* Note: to guarantee best results, either:
*
*
* - make sure {@code num_nodes ≥ width}
* - or, call {@link #stbrp_setup_allow_out_of_mem setup_allow_out_of_mem} with {@code allow_out_of_mem = 1}
*
*
* If you don't do either of the above things, widths will be quantized to multiples of small integers to guarantee the algorithm doesn't run out of
* temporary storage.
*
* If you do #2, then the non-quantized algorithm will be used, but the algorithm may run out of temporary storage and be unable to pack some rectangles.
*
* @param context an {@link STBRPContext} struct
* @param width the rectangle width
* @param height the rectangle height
* @param nodes an array of {@link STBRPNode} structs
*/
public static void stbrp_init_target(@NativeType("stbrp_context *") STBRPContext context, int width, int height, @NativeType("stbrp_node *") STBRPNode.Buffer nodes) {
nstbrp_init_target(context.address(), width, height, nodes.address(), nodes.remaining());
}
// --- [ stbrp_setup_allow_out_of_mem ] ---
/** Unsafe version of: {@link #stbrp_setup_allow_out_of_mem setup_allow_out_of_mem} */
public static native void nstbrp_setup_allow_out_of_mem(long context, int allow_out_of_mem);
/**
* Optionally call this function after init but before doing any packing to change the handling of the out-of-temp-memory scenario, described in
* {@link #stbrp_init_target init_target}. If you call init again, this will be reset to the default (false).
*
* @param context an {@link STBRPContext} struct
* @param allow_out_of_mem 1 to allow running out of temporary storage
*/
public static void stbrp_setup_allow_out_of_mem(@NativeType("stbrp_context *") STBRPContext context, @NativeType("int") boolean allow_out_of_mem) {
nstbrp_setup_allow_out_of_mem(context.address(), allow_out_of_mem ? 1 : 0);
}
// --- [ stbrp_setup_heuristic ] ---
/** Unsafe version of: {@link #stbrp_setup_heuristic setup_heuristic} */
public static native void nstbrp_setup_heuristic(long context, int heuristic);
/**
* Optionally select which packing heuristic the library should use. Different heuristics will produce better/worse results for different data sets. If
* you call init again, this will be reset to the default.
*
* @param context an {@link STBRPContext} struct
* @param heuristic the packing heuristic
*/
public static void stbrp_setup_heuristic(@NativeType("stbrp_context *") STBRPContext context, int heuristic) {
nstbrp_setup_heuristic(context.address(), heuristic);
}
}