Class DeepImage

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

    public class DeepImage
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource

    Layout

    
     struct DeepImage {
         char const ** channel_names;
         float *** image();
         int ** offset_table(int);
         int num_channels;
         int width;
         int height;
         char[4];
     }
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DeepImage.Buffer
      An array of DeepImage structs.
      • Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

        org.lwjgl.system.Pointer.Default
      • Nested classes/interfaces inherited from class org.lwjgl.system.Struct

        org.lwjgl.system.Struct.StructValidation
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ALIGNOF
      The struct alignment in bytes.
      static int CHANNEL_NAMES
      HEIGHT
      IMAGE
      NUM_CHANNELS
      OFFSET_TABLE
      The struct member offsets.
      static int SIZEOF
      The struct size in bytes.
      static int WIDTH
      The struct member offsets.
      • Fields inherited from interface org.lwjgl.system.Pointer

        BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
    • Constructor Summary

      Constructors 
      Constructor Description
      DeepImage​(java.nio.ByteBuffer container)
      Creates a DeepImage instance at the current position of the specified ByteBuffer container.
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • CHANNEL_NAMES, IMAGE, OFFSET_TABLE, NUM_CHANNELS, WIDTH, HEIGHT

        The struct member offsets.
    • Constructor Detail

      • DeepImage

        public DeepImage​(java.nio.ByteBuffer container)
        Creates a DeepImage instance at the current position of the specified 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.

    • Method Detail

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct
      • channel_names

        public org.lwjgl.PointerBuffer channel_names()
        Returns:
        a PointerBuffer view of the data pointed to by the channel_names field.
      • image

        public org.lwjgl.PointerBuffer image()
        image[channels][scanlines][samples]
      • offset_table

        public org.lwjgl.PointerBuffer offset_table​(int capacity)
        Parameters:
        capacity - the number of elements in the returned buffer
        Returns:
        offset_table[scanline][offsets]
      • num_channels

        public int num_channels()
        Returns:
        the value of the num_channels field.
      • width

        public int width()
        Returns:
        the value of the width field.
      • height

        public int height()
        Returns:
        the value of the height field.
      • channel_names

        public DeepImage channel_names​(org.lwjgl.PointerBuffer value)
        Sets the address of the specified PointerBuffer to the channel_names field.
      • image

        public DeepImage image​(org.lwjgl.PointerBuffer value)
        Sets the address of the specified PointerBuffer to the image() field.
      • offset_table

        public DeepImage offset_table​(org.lwjgl.PointerBuffer value)
        Sets the address of the specified PointerBuffer to the offset_table(int) field.
      • num_channels

        public DeepImage num_channels​(int value)
        Sets the specified value to the num_channels field.
      • width

        public DeepImage width​(int value)
        Sets the specified value to the width field.
      • height

        public DeepImage height​(int value)
        Sets the specified value to the height field.
      • set

        public DeepImage set​(org.lwjgl.PointerBuffer channel_names,
                             org.lwjgl.PointerBuffer image,
                             org.lwjgl.PointerBuffer offset_table,
                             int num_channels,
                             int width,
                             int height)
        Initializes this struct with the specified values.
      • set

        public DeepImage set​(DeepImage src)
        Copies the specified struct data to this struct.
        Parameters:
        src - the source struct
        Returns:
        this struct
      • malloc

        public static DeepImage malloc()
        Returns a new DeepImage instance allocated with memAlloc. The instance must be explicitly freed.
      • calloc

        public static DeepImage calloc()
        Returns a new DeepImage instance allocated with memCalloc. The instance must be explicitly freed.
      • create

        public static DeepImage create()
        Returns a new DeepImage instance allocated with BufferUtils.
      • create

        public static DeepImage create​(long address)
        Returns a new DeepImage instance for the specified memory address.
      • createSafe

        @Nullable
        public static DeepImage createSafe​(long address)
        Like create, but returns null if address is NULL.
      • malloc

        public static DeepImage.Buffer malloc​(int capacity)
        Returns a new DeepImage.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity
      • calloc

        public static DeepImage.Buffer calloc​(int capacity)
        Returns a new DeepImage.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity
      • create

        public static DeepImage.Buffer create​(int capacity)
        Returns a new DeepImage.Buffer instance allocated with BufferUtils.
        Parameters:
        capacity - the buffer capacity
      • create

        public static DeepImage.Buffer create​(long address,
                                              int capacity)
        Create a DeepImage.Buffer instance at the specified memory.
        Parameters:
        address - the memory address
        capacity - the buffer capacity
      • createSafe

        @Nullable
        public static DeepImage.Buffer createSafe​(long address,
                                                  int capacity)
        Like create, but returns null if address is NULL.
      • mallocStack

        @Deprecated
        public static DeepImage mallocStack()
        Deprecated.
        Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
      • callocStack

        @Deprecated
        public static DeepImage callocStack()
        Deprecated.
        Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
      • mallocStack

        @Deprecated
        public static DeepImage mallocStack​(org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
      • callocStack

        @Deprecated
        public static DeepImage callocStack​(org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
      • mallocStack

        @Deprecated
        public static DeepImage.Buffer mallocStack​(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
      • callocStack

        @Deprecated
        public static DeepImage.Buffer callocStack​(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
      • malloc

        public static DeepImage malloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new DeepImage instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • calloc

        public static DeepImage calloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new DeepImage instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • malloc

        public static DeepImage.Buffer malloc​(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
        Returns a new DeepImage.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • calloc

        public static DeepImage.Buffer calloc​(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
        Returns a new DeepImage.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • nchannel_names

        public static org.lwjgl.PointerBuffer nchannel_names​(long struct)
        Unsafe version of channel_names.
      • nimage

        public static org.lwjgl.PointerBuffer nimage​(long struct)
        Unsafe version of image.
      • noffset_table

        public static org.lwjgl.PointerBuffer noffset_table​(long struct,
                                                            int capacity)
        Unsafe version of offset_table.
      • nnum_channels

        public static int nnum_channels​(long struct)
        Unsafe version of num_channels().
      • nwidth

        public static int nwidth​(long struct)
        Unsafe version of width().
      • nheight

        public static int nheight​(long struct)
        Unsafe version of height().
      • nchannel_names

        public static void nchannel_names​(long struct,
                                          org.lwjgl.PointerBuffer value)
        Unsafe version of channel_names.
      • nimage

        public static void nimage​(long struct,
                                  org.lwjgl.PointerBuffer value)
        Unsafe version of image.
      • noffset_table

        public static void noffset_table​(long struct,
                                         org.lwjgl.PointerBuffer value)
        Unsafe version of offset_table.
      • nnum_channels

        public static void nnum_channels​(long struct,
                                         int value)
        Sets the specified value to the num_channels field of the specified struct.
      • nwidth

        public static void nwidth​(long struct,
                                  int value)
        Unsafe version of width.
      • nheight

        public static void nheight​(long struct,
                                   int value)
        Unsafe version of height.
      • validate

        public static void validate​(long struct)
        Validates pointer members that should not be NULL.
        Parameters:
        struct - the struct to validate