Package org.lwjgl.stb

Class STBImageWrite


  • public class STBImageWrite
extends java.lang.Object
    Native bindings to stb_image_write.h from the stb library.

    ABOUT

    This header file is a library for writing images to C stdio.

    The PNG output is not optimal; it is 20-50% larger than the file written by a decent optimizing implementation. This library is designed for source code compactness and simplicitly, not optimal image file size or run-time performance.

    USAGE

    There are four functions, one for each image file format:

    int stbi_write_png(char const *filename, int w, int h, int comp, const void *data, int stride_in_bytes);
int stbi_write_bmp(char const *filename, int w, int h, int comp, const void *data);
int stbi_write_tga(char const *filename, int w, int h, int comp, const void *data);
int stbi_write_hdr(char const *filename, int w, int h, int comp, const void *data);

    There are also four equivalent functions that use an arbitrary write function. You are expected to open/close your file-equivalent before and after calling these:

    int stbi_write_png_to_func(stbi_write_func *func, void *context, int w, int h, int comp, const void  *data, int stride_in_bytes);
int stbi_write_bmp_to_func(stbi_write_func *func, void *context, int w, int h, int comp, const void  *data);
int stbi_write_tga_to_func(stbi_write_func *func, void *context, int w, int h, int comp, const void  *data);
int stbi_write_hdr_to_func(stbi_write_func *func, void *context, int w, int h, int comp, const float *data);

    where the callback is:

    void stbi_write_func(void *context, void *data, int size);

    The functions create an image file defined by the parameters. The image is a rectangle of pixels stored from left-to-right, top-to-bottom. Each pixel contains comp channels of data stored interleaved with 8-bits per channel, in the following order: 1=Y, 2=YA, 3=RGB, 4=RGBA. (Y is monochrome color.) The rectangle is w pixels wide and h pixels tall. The *data pointer points to the first byte of the top-left-most pixel.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.nio.IntBuffer stbi_write_tga_with_rle
      Returns the address of the global variable stbi_write_tga_with_rle.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method and Description
      static boolean stbi_write_bmp_to_func(STBIWriteCallbackI func, long context, int w, int h, int comp, java.nio.ByteBuffer data)
      Callback version of write_bmp.
      static boolean stbi_write_bmp(java.nio.ByteBuffer filename, int w, int h, int comp, java.nio.ByteBuffer data)
      Writes a BMP image file.
      static boolean stbi_write_bmp(java.lang.CharSequence filename, int w, int h, int comp, java.nio.ByteBuffer data)
      Writes a BMP image file.
      static boolean stbi_write_hdr_to_func(STBIWriteCallbackI func, long context, int w, int h, int comp, float[] data)
      Array version of: write_hdr_to_func
      static boolean stbi_write_hdr_to_func(STBIWriteCallbackI func, long context, int w, int h, int comp, java.nio.FloatBuffer data)
      Callback version of write_hdr.
      static boolean stbi_write_hdr(java.nio.ByteBuffer filename, int w, int h, int comp, float[] data)
      Array version of: write_hdr
      static boolean stbi_write_hdr(java.nio.ByteBuffer filename, int w, int h, int comp, java.nio.FloatBuffer data)
      Writes an HDR image file.
      static boolean stbi_write_hdr(java.lang.CharSequence filename, int w, int h, int comp, float[] data)
      Array version of: write_hdr
      static boolean stbi_write_hdr(java.lang.CharSequence filename, int w, int h, int comp, java.nio.FloatBuffer data)
      Writes an HDR image file.
      static boolean stbi_write_png_to_func(STBIWriteCallbackI func, long context, int w, int h, int comp, java.nio.ByteBuffer data, int stride_in_bytes)
      Callback version of write_png.
      static boolean stbi_write_png(java.nio.ByteBuffer filename, int w, int h, int comp, java.nio.ByteBuffer data, int stride_in_bytes)
      Writes a PNR image file.
      static boolean stbi_write_png(java.lang.CharSequence filename, int w, int h, int comp, java.nio.ByteBuffer data, int stride_in_bytes)
      Writes a PNR image file.
      static boolean stbi_write_tga_to_func(STBIWriteCallbackI func, long context, int w, int h, int comp, java.nio.ByteBuffer data)
      Callback version of write_tga.
      static boolean stbi_write_tga(java.nio.ByteBuffer filename, int w, int h, int comp, java.nio.ByteBuffer data)
      Writes a TGA image file.
      static boolean stbi_write_tga(java.lang.CharSequence filename, int w, int h, int comp, java.nio.ByteBuffer data)
      Writes a TGA image file.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • stbi_write_tga_with_rle

        Returns the address of the global variable stbi_write_tga_with_rle.

    • Method Detail

      • stbi_write_png

        public static boolean stbi_write_png(java.nio.ByteBuffer filename,
                                     int w,
                                     int h,
                                     int comp,
                                     java.nio.ByteBuffer data,
                                     int stride_in_bytes)

public static boolean stbi_write_png(java.lang.CharSequence filename,
                                     int w,
                                     int h,
                                     int comp,
                                     java.nio.ByteBuffer data,
                                     int stride_in_bytes)
        Writes a PNR image file.

        PNG creates output files with the same number of components as the input.

        PNG supports writing rectangles of data even when the bytes storing rows of data are not consecutive in memory (e.g. sub-rectangles of a larger image), by supplying the stride between the beginning of adjacent rows. The other formats do not. (Thus you cannot write a native-format BMP through the BMP writer, both because it is in BGR order and because it may have padding at the end of the line.)

        Parameters:
        filename - the image file path
        w - the image width, in pixels
        h - the image height, in pixels
        comp - the number of channels in each pixel
        data - the image data
        stride_in_bytes - the distance in bytes from the first byte of a row of pixels to the first byte of the next row of pixels
        Returns:
        1 on success, 0 on failure

      • stbi_write_bmp

        public static boolean stbi_write_bmp(java.nio.ByteBuffer filename,
                                     int w,
                                     int h,
                                     int comp,
                                     java.nio.ByteBuffer data)

public static boolean stbi_write_bmp(java.lang.CharSequence filename,
                                     int w,
                                     int h,
                                     int comp,
                                     java.nio.ByteBuffer data)
        Writes a BMP image file.

        The BMP format expands Y to RGB in the file format and does not output alpha.

        Parameters:
        filename - the image file path
        w - the image width, in pixels
        h - the image height, in pixels
        comp - the number of channels in each pixel
        data - the image data
        Returns:
        1 on success, 0 on failure

      • stbi_write_tga

        public static boolean stbi_write_tga(java.nio.ByteBuffer filename,
                                     int w,
                                     int h,
                                     int comp,
                                     java.nio.ByteBuffer data)

public static boolean stbi_write_tga(java.lang.CharSequence filename,
                                     int w,
                                     int h,
                                     int comp,
                                     java.nio.ByteBuffer data)
        Writes a TGA image file.

        TGA supports RLE or non-RLE compressed data. To use non-RLE-compressed data, set the global variable stbi_write_tga_with_rle to 0. The variable can be accessed with write_tga_with_rle.

        Parameters:
        filename - the image file path
        w - the image width, in pixels
        h - the image height, in pixels
        comp - the number of channels in each pixel
        data - the image data
        Returns:
        1 on success, 0 on failure

      • stbi_write_hdr

        public static boolean stbi_write_hdr(java.nio.ByteBuffer filename,
                                     int w,
                                     int h,
                                     int comp,
                                     java.nio.FloatBuffer data)

public static boolean stbi_write_hdr(java.lang.CharSequence filename,
                                     int w,
                                     int h,
                                     int comp,
                                     java.nio.FloatBuffer data)
        Writes an HDR image file.

        HDR expects linear float data. Since the format is always 32-bit rgb(e) data, alpha (if provided) is discarded, and for monochrome data it is replicated across all three channels.

        Parameters:
        filename - the image file path
        w - the image width, in pixels
        h - the image height, in pixels
        comp - the number of channels in each pixel
        data - the image data
        Returns:
        1 on success, 0 on failure

      • stbi_write_png_to_func

        public static boolean stbi_write_png_to_func(STBIWriteCallbackI func,
                                             long context,
                                             int w,
                                             int h,
                                             int comp,
                                             java.nio.ByteBuffer data,
                                             int stride_in_bytes)
        Callback version of write_png.
        Parameters:
        func - the callback function
        context - a context that will be passed to func
        w - the image width, in pixels
        h - the image height, in pixels
        comp - the number of channels in each pixel
        data - the image data
        stride_in_bytes - the distance in bytes from the first byte of a row of pixels to the first byte of the next row of pixels
        Returns:
        1 on success, 0 on failure

      • stbi_write_bmp_to_func

        public static boolean stbi_write_bmp_to_func(STBIWriteCallbackI func,
                                             long context,
                                             int w,
                                             int h,
                                             int comp,
                                             java.nio.ByteBuffer data)
        Callback version of write_bmp.
        Parameters:
        func - the callback function
        context - a context that will be passed to func
        w - the image width, in pixels
        h - the image height, in pixels
        comp - the number of channels in each pixel
        data - the image data
        Returns:
        1 on success, 0 on failure

      • stbi_write_tga_to_func

        public static boolean stbi_write_tga_to_func(STBIWriteCallbackI func,
                                             long context,
                                             int w,
                                             int h,
                                             int comp,
                                             java.nio.ByteBuffer data)
        Callback version of write_tga.
        Parameters:
        func - the callback function
        context - a context that will be passed to func
        w - the image width, in pixels
        h - the image height, in pixels
        comp - the number of channels in each pixel
        data - the image data
        Returns:
        1 on success, 0 on failure

      • stbi_write_hdr_to_func

        public static boolean stbi_write_hdr_to_func(STBIWriteCallbackI func,
                                             long context,
                                             int w,
                                             int h,
                                             int comp,
                                             java.nio.FloatBuffer data)
        Callback version of write_hdr.
        Parameters:
        func - the callback function
        context - a context that will be passed to func
        w - the image width, in pixels
        h - the image height, in pixels
        comp - the number of channels in each pixel
        data - the image data
        Returns:
        1 on success, 0 on failure

      • stbi_write_hdr

        public static boolean stbi_write_hdr(java.nio.ByteBuffer filename,
                                     int w,
                                     int h,
                                     int comp,
                                     float[] data)

public static boolean stbi_write_hdr(java.lang.CharSequence filename,
                                     int w,
                                     int h,
                                     int comp,
                                     float[] data)
        Array version of: write_hdr

      • stbi_write_hdr_to_func

        public static boolean stbi_write_hdr_to_func(STBIWriteCallbackI func,
                                             long context,
                                             int w,
                                             int h,
                                             int comp,
                                             float[] data)
        Array version of: write_hdr_to_func