Class ExrScanlineRequest

All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer

public class ExrScanlineRequest extends Struct<ExrScanlineRequest> implements NativeResource
struct ExrScanlineRequest {
    ExrPart part;
    int32_t y_start;
    int32_t num_lines;
    ExrBuffer output;
    uint32_t channels_mask;
    uint32_t output_pixel_type;
    uint32_t output_layout;
}
  • Field Details

    • SIZEOF

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

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

      public static final int PART
      The struct member offsets.
    • Y_START

      public static final int Y_START
      The struct member offsets.
    • NUM_LINES

      public static final int NUM_LINES
      The struct member offsets.
    • OUTPUT

      public static final int OUTPUT
      The struct member offsets.
    • CHANNELS_MASK

      public static final int CHANNELS_MASK
      The struct member offsets.
    • OUTPUT_PIXEL_TYPE

      public static final int OUTPUT_PIXEL_TYPE
      The struct member offsets.
    • OUTPUT_LAYOUT

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

    • ExrScanlineRequest

      public ExrScanlineRequest(ByteBuffer container)
      Creates a ExrScanlineRequest 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<ExrScanlineRequest>
    • part

      @NativeType("ExrPart") public long part()
      Returns:
      the value of the part field.
    • y_start

      @NativeType("int32_t") public int y_start()
      Returns:
      the value of the y_start field.
    • num_lines

      @NativeType("int32_t") public int num_lines()
      Returns:
      the value of the num_lines field.
    • output

      public ExrBuffer output()
      Returns:
      a ExrBuffer view of the output field.
    • channels_mask

      @NativeType("uint32_t") public int channels_mask()
      Returns:
      the value of the channels_mask field.
    • output_pixel_type

      @NativeType("uint32_t") public int output_pixel_type()
      Returns:
      the value of the output_pixel_type field.
    • output_layout

      @NativeType("uint32_t") public int output_layout()
      Returns:
      the value of the output_layout field.
    • part

      public ExrScanlineRequest part(@NativeType("ExrPart") long value)
      Sets the specified value to the part field.
    • y_start

      public ExrScanlineRequest y_start(@NativeType("int32_t") int value)
      Sets the specified value to the y_start field.
    • num_lines

      public ExrScanlineRequest num_lines(@NativeType("int32_t") int value)
      Sets the specified value to the num_lines field.
    • output

      public ExrScanlineRequest output(ExrBuffer value)
      Copies the specified ExrBuffer to the output field.
    • output

      public ExrScanlineRequest output(Consumer<ExrBuffer> consumer)
      Passes the output field to the specified Consumer.
    • channels_mask

      public ExrScanlineRequest channels_mask(@NativeType("uint32_t") int value)
      Sets the specified value to the channels_mask field.
    • output_pixel_type

      public ExrScanlineRequest output_pixel_type(@NativeType("uint32_t") int value)
      Sets the specified value to the output_pixel_type field.
    • output_layout

      public ExrScanlineRequest output_layout(@NativeType("uint32_t") int value)
      Sets the specified value to the output_layout field.
    • set

      public ExrScanlineRequest set(long part, int y_start, int num_lines, ExrBuffer output, int channels_mask, int output_pixel_type, int output_layout)
      Initializes this struct with the specified values.
    • set

      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct
    • malloc

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

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

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

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

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

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

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

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

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

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

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

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

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

      public static ExrScanlineRequest.Buffer calloc(int capacity, MemoryStack stack)
      Returns a new ExrScanlineRequest.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
    • npart

      public static long npart(long struct)
      Unsafe version of part().
    • ny_start

      public static int ny_start(long struct)
      Unsafe version of y_start().
    • nnum_lines

      public static int nnum_lines(long struct)
      Unsafe version of num_lines().
    • noutput

      public static ExrBuffer noutput(long struct)
      Unsafe version of output().
    • nchannels_mask

      public static int nchannels_mask(long struct)
      Unsafe version of channels_mask().
    • noutput_pixel_type

      public static int noutput_pixel_type(long struct)
      Unsafe version of output_pixel_type().
    • noutput_layout

      public static int noutput_layout(long struct)
      Unsafe version of output_layout().
    • npart

      public static void npart(long struct, long value)
      Unsafe version of part.
    • ny_start

      public static void ny_start(long struct, int value)
      Unsafe version of y_start.
    • nnum_lines

      public static void nnum_lines(long struct, int value)
      Unsafe version of num_lines.
    • noutput

      public static void noutput(long struct, ExrBuffer value)
      Unsafe version of output.
    • nchannels_mask

      public static void nchannels_mask(long struct, int value)
      Unsafe version of channels_mask.
    • noutput_pixel_type

      public static void noutput_pixel_type(long struct, int value)
      Unsafe version of output_pixel_type.
    • noutput_layout

      public static void noutput_layout(long struct, int value)
      Unsafe version of output_layout.
    • validate

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