Class DeepImage

All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer

public class DeepImage extends Struct<DeepImage> implements NativeResource

Layout


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

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.
    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.
    • CHANNEL_NAMES

      public static final int CHANNEL_NAMES
      The struct member offsets.
    • IMAGE

      public static final int IMAGE
      The struct member offsets.
    • OFFSET_TABLE

      public static final int OFFSET_TABLE
      The struct member offsets.
    • NUM_CHANNELS

      public static final int NUM_CHANNELS
      The struct member offsets.
    • WIDTH

      public static final int WIDTH
      The struct member offsets.
    • HEIGHT

      public static final int HEIGHT
      The struct member offsets.
  • Constructor Details

    • DeepImage

      public DeepImage(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 Details

    • sizeof

      public int sizeof()
      Description copied from class: Struct
      Returns sizeof(struct).
      Specified by:
      sizeof in class Struct<DeepImage>
    • channel_names

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

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

      public 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(PointerBuffer value)
      Sets the address of the specified PointerBuffer to the channel_names field.
    • image

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

      public DeepImage offset_table(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(PointerBuffer channel_names, PointerBuffer image, 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(MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
    • callocStack

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

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

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

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

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

      public static DeepImage malloc(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(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, MemoryStack stack)
      Returns a new DeepImage.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate
    • calloc

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

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

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

      public static 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, PointerBuffer value)
      Unsafe version of channel_names.
    • nimage

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

      public static void noffset_table(long struct, 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