Class DeepImage

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

    public class DeepImage
    extends Struct
    implements NativeResource

    Member documentation

    • image – image[channels][scanlines][samples]
    • offset_table – offset_table[scanline][offsets]

    Layout

    
     struct DeepImage {
         char const ** channel_names;
         float *** image;
         int ** offset_table;
         int num_channels;
         int width;
         int height;
         char[4];
     }
    • 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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct
      • channel_names

        public PointerBuffer channel_names()
        Returns a PointerBuffer view of the data pointed to by the channel_names field.
      • offset_table

        public PointerBuffer offset_table​(int capacity)
        Returns a PointerBuffer view of the data pointed to by the offset_table field.
        Parameters:
        capacity - the number of elements in the returned buffer
      • 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.
      • 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​(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​(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​(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.
      • callocStack

        public static DeepImage callocStack()
        Returns a new DeepImage instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

        public static DeepImage mallocStack​(MemoryStack stack)
        Returns a new DeepImage instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static DeepImage callocStack​(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
      • callocStack

        public static DeepImage.Buffer callocStack​(int capacity)
        Returns a new DeepImage.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
        Parameters:
        capacity - the buffer capacity
      • callocStack

        public static DeepImage.Buffer callocStack​(int capacity,
                                                   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
      • 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().
      • nimage

        public static void nimage​(long struct,
                                  PointerBuffer value)
        Unsafe version of image.
      • 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
      • validate

        public static void validate​(long array,
                                    int count)
        Calls validate(long) for each struct contained in the specified struct array.
        Parameters:
        array - the struct array to validate
        count - the number of structs in array