Class VkVideoEncodeRateControlInfoKHR

java.lang.Object
overrungl.struct.GroupType
overrungl.vulkan.khr.struct.VkVideoEncodeRateControlInfoKHR
All Implemented Interfaces:
Addressable
public final class VkVideoEncodeRateControlInfoKHR extends GroupType

Represents VkVideoEncodeRateControlInfoKHR.

Layout

struct VkVideoEncodeRateControlInfoKHR {
    (int) VkStructureType sType;
    const void* pNext;
    ((uint32_t) VkFlags) VkVideoEncodeRateControlFlagsKHR flags;
    (int) VkVideoEncodeRateControlModeFlagBitsKHR rateControlMode;
    uint32_t layerCount;
    const VkVideoEncodeRateControlLayerInfoKHR* pLayers;
    uint32_t virtualBufferSizeInMs;
    uint32_t initialVirtualBufferSizeInMs;
};

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT
      The struct layout of VkVideoEncodeRateControlInfoKHR.

    • OFFSET_sType

      public static final long OFFSET_sType
      The byte offset of sType.

    • LAYOUT_sType

      public static final MemoryLayout LAYOUT_sType
      The memory layout of sType.

    • VH_sType

      public static final VarHandle VH_sType
      The VarHandle of sType of type (MemorySegment base, long baseOffset, long index)MemorySegment.

    • OFFSET_pNext

      public static final long OFFSET_pNext
      The byte offset of pNext.

    • LAYOUT_pNext

      public static final MemoryLayout LAYOUT_pNext
      The memory layout of pNext.

    • VH_pNext

      public static final VarHandle VH_pNext
      The VarHandle of pNext of type (MemorySegment base, long baseOffset, long index)MemorySegment.

    • OFFSET_flags

      public static final long OFFSET_flags
      The byte offset of flags.

    • LAYOUT_flags

      public static final MemoryLayout LAYOUT_flags
      The memory layout of flags.

    • VH_flags

      public static final VarHandle VH_flags
      The VarHandle of flags of type (MemorySegment base, long baseOffset, long index)MemorySegment.

    • OFFSET_rateControlMode

      public static final long OFFSET_rateControlMode
      The byte offset of rateControlMode.

    • LAYOUT_rateControlMode

      public static final MemoryLayout LAYOUT_rateControlMode
      The memory layout of rateControlMode.

    • VH_rateControlMode

      public static final VarHandle VH_rateControlMode
      The VarHandle of rateControlMode of type (MemorySegment base, long baseOffset, long index)MemorySegment.

    • OFFSET_layerCount

      public static final long OFFSET_layerCount
      The byte offset of layerCount.

    • LAYOUT_layerCount

      public static final MemoryLayout LAYOUT_layerCount
      The memory layout of layerCount.

    • VH_layerCount

      public static final VarHandle VH_layerCount
      The VarHandle of layerCount of type (MemorySegment base, long baseOffset, long index)MemorySegment.

    • OFFSET_pLayers

      public static final long OFFSET_pLayers
      The byte offset of pLayers.

    • LAYOUT_pLayers

      public static final MemoryLayout LAYOUT_pLayers
      The memory layout of pLayers.

    • VH_pLayers

      public static final VarHandle VH_pLayers
      The VarHandle of pLayers of type (MemorySegment base, long baseOffset, long index)MemorySegment.

    • OFFSET_virtualBufferSizeInMs

      public static final long OFFSET_virtualBufferSizeInMs
      The byte offset of virtualBufferSizeInMs.

    • LAYOUT_virtualBufferSizeInMs

      public static final MemoryLayout LAYOUT_virtualBufferSizeInMs
      The memory layout of virtualBufferSizeInMs.

    • VH_virtualBufferSizeInMs

      public static final VarHandle VH_virtualBufferSizeInMs
      The VarHandle of virtualBufferSizeInMs of type (MemorySegment base, long baseOffset, long index)MemorySegment.

    • OFFSET_initialVirtualBufferSizeInMs

      public static final long OFFSET_initialVirtualBufferSizeInMs
      The byte offset of initialVirtualBufferSizeInMs.

    • LAYOUT_initialVirtualBufferSizeInMs

      public static final MemoryLayout LAYOUT_initialVirtualBufferSizeInMs
      The memory layout of initialVirtualBufferSizeInMs.

    • VH_initialVirtualBufferSizeInMs

      public static final VarHandle VH_initialVirtualBufferSizeInMs
      The VarHandle of initialVirtualBufferSizeInMs of type (MemorySegment base, long baseOffset, long index)MemorySegment.

  • Constructor Details

    • VkVideoEncodeRateControlInfoKHR

      public VkVideoEncodeRateControlInfoKHR(MemorySegment segment, long elementCount)
      Creates VkVideoEncodeRateControlInfoKHR with the given segment.
      Parameters:
      segment - the memory segment
      elementCount - the element count of this struct buffer

  • Method Details

    • of

      public static VkVideoEncodeRateControlInfoKHR of(MemorySegment segment)
      Creates VkVideoEncodeRateControlInfoKHR with the given segment.
      Parameters:
      segment - the memory segment
      Returns:
      the created instance or null if the segment is NULL

    • ofNative

      public static VkVideoEncodeRateControlInfoKHR ofNative(MemorySegment segment)

      Creates VkVideoEncodeRateControlInfoKHR with the given segment.

      Reinterprets the segment if zero-length.

      Parameters:
      segment - the memory segment
      Returns:
      the created instance or null if the segment is NULL

    • ofNative

      public static VkVideoEncodeRateControlInfoKHR ofNative(MemorySegment segment, long count)

      Creates VkVideoEncodeRateControlInfoKHR with the given segment.

      Reinterprets the segment if zero-length.

      Parameters:
      segment - the memory segment
      count - the count of the buffer
      Returns:
      the created instance or null if the segment is NULL

    • alloc

      public static VkVideoEncodeRateControlInfoKHR alloc(SegmentAllocator allocator)
      Allocates a VkVideoEncodeRateControlInfoKHR with the given segment allocator.
      Parameters:
      allocator - the segment allocator
      Returns:
      the allocated VkVideoEncodeRateControlInfoKHR

    • alloc

      public static VkVideoEncodeRateControlInfoKHR alloc(SegmentAllocator allocator, long count)
      Allocates a VkVideoEncodeRateControlInfoKHR with the given segment allocator and count.
      Parameters:
      allocator - the segment allocator
      count - the count
      Returns:
      the allocated VkVideoEncodeRateControlInfoKHR

    • copyFrom

      public VkVideoEncodeRateControlInfoKHR copyFrom(VkVideoEncodeRateControlInfoKHR src)
      Copies from the given source.
      Parameters:
      src - the source
      Returns:
      this

    • reinterpret

      public VkVideoEncodeRateControlInfoKHR reinterpret(long count)
      Reinterprets this buffer with the given count.
      Parameters:
      count - the new count
      Returns:
      the reinterpreted buffer

    • sType

      public static int sType(MemorySegment segment, long index)
      Returns sType at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      Returns:
      sType at the given index

    • sType

      public int sType()
      Returns sType.
      Returns:
      sType

    • sType

      public static void sType(MemorySegment segment, long index, int value)
      Sets sType with the given value at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      value - the value

    • sType

      public VkVideoEncodeRateControlInfoKHR sType(int value)
      Sets sType with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • pNext

      public static MemorySegment pNext(MemorySegment segment, long index)
      Returns pNext at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      Returns:
      pNext at the given index

    • pNext

      public MemorySegment pNext()
      Returns pNext.
      Returns:
      pNext

    • pNext

      public static void pNext(MemorySegment segment, long index, MemorySegment value)
      Sets pNext with the given value at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      value - the value

    • pNext

      public VkVideoEncodeRateControlInfoKHR pNext(MemorySegment value)
      Sets pNext with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • flags

      public static int flags(MemorySegment segment, long index)
      Returns flags at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      Returns:
      flags at the given index

    • flags

      public int flags()
      Returns flags.
      Returns:
      flags

    • flags

      public static void flags(MemorySegment segment, long index, int value)
      Sets flags with the given value at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      value - the value

    • flags

      public VkVideoEncodeRateControlInfoKHR flags(int value)
      Sets flags with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • rateControlMode

      public static int rateControlMode(MemorySegment segment, long index)
      Returns rateControlMode at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      Returns:
      rateControlMode at the given index

    • rateControlMode

      public int rateControlMode()
      Returns rateControlMode.
      Returns:
      rateControlMode

    • rateControlMode

      public static void rateControlMode(MemorySegment segment, long index, int value)
      Sets rateControlMode with the given value at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      value - the value

    • rateControlMode

      public VkVideoEncodeRateControlInfoKHR rateControlMode(int value)
      Sets rateControlMode with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • layerCount

      public static int layerCount(MemorySegment segment, long index)
      Returns layerCount at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      Returns:
      layerCount at the given index

    • layerCount

      public int layerCount()
      Returns layerCount.
      Returns:
      layerCount

    • layerCount

      public static void layerCount(MemorySegment segment, long index, int value)
      Sets layerCount with the given value at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      value - the value

    • layerCount

      public VkVideoEncodeRateControlInfoKHR layerCount(int value)
      Sets layerCount with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • pLayers

      public static MemorySegment pLayers(MemorySegment segment, long index)
      Returns pLayers at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      Returns:
      pLayers at the given index

    • pLayers

      public MemorySegment pLayers()
      Returns pLayers.
      Returns:
      pLayers

    • pLayers

      public static void pLayers(MemorySegment segment, long index, MemorySegment value)
      Sets pLayers with the given value at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      value - the value

    • pLayers

      public VkVideoEncodeRateControlInfoKHR pLayers(MemorySegment value)
      Sets pLayers with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • virtualBufferSizeInMs

      public static int virtualBufferSizeInMs(MemorySegment segment, long index)
      Returns virtualBufferSizeInMs at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      Returns:
      virtualBufferSizeInMs at the given index

    • virtualBufferSizeInMs

      public int virtualBufferSizeInMs()
      Returns virtualBufferSizeInMs.
      Returns:
      virtualBufferSizeInMs

    • virtualBufferSizeInMs

      public static void virtualBufferSizeInMs(MemorySegment segment, long index, int value)
      Sets virtualBufferSizeInMs with the given value at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      value - the value

    • virtualBufferSizeInMs

      public VkVideoEncodeRateControlInfoKHR virtualBufferSizeInMs(int value)
      Sets virtualBufferSizeInMs with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • initialVirtualBufferSizeInMs

      public static int initialVirtualBufferSizeInMs(MemorySegment segment, long index)
      Returns initialVirtualBufferSizeInMs at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      Returns:
      initialVirtualBufferSizeInMs at the given index

    • initialVirtualBufferSizeInMs

      public int initialVirtualBufferSizeInMs()
      Returns initialVirtualBufferSizeInMs.
      Returns:
      initialVirtualBufferSizeInMs

    • initialVirtualBufferSizeInMs

      public static void initialVirtualBufferSizeInMs(MemorySegment segment, long index, int value)
      Sets initialVirtualBufferSizeInMs with the given value at the given index.
      Parameters:
      segment - the segment of the struct
      index - the index of the struct buffer
      value - the value

    • initialVirtualBufferSizeInMs

      public VkVideoEncodeRateControlInfoKHR initialVirtualBufferSizeInMs(int value)
      Sets initialVirtualBufferSizeInMs with the given value.
      Parameters:
      value - the value
      Returns:
      this

    • asSlice

      public VkVideoEncodeRateControlInfoKHR asSlice(long index)
      Creates a slice of VkVideoEncodeRateControlInfoKHR.
      Parameters:
      index - the index of the struct buffer
      Returns:
      the slice of VkVideoEncodeRateControlInfoKHR

    • asSlice

      public VkVideoEncodeRateControlInfoKHR asSlice(long index, long count)
      Creates a slice of VkVideoEncodeRateControlInfoKHR.
      Parameters:
      index - the index of the struct buffer
      count - the count
      Returns:
      the slice of VkVideoEncodeRateControlInfoKHR

    • at

      public VkVideoEncodeRateControlInfoKHR at(long index, Consumer<VkVideoEncodeRateControlInfoKHR> func)
      Visits VkVideoEncodeRateControlInfoKHR buffer at the given index.
      Parameters:
      index - the index of this buffer
      func - the function to run with the slice of this buffer
      Returns:
      this

    • sTypeAt

      public int sTypeAt(long index)
      Returns sType at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      sType at the given index

    • sTypeAt

      public VkVideoEncodeRateControlInfoKHR sTypeAt(long index, int value)
      Sets sType with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • pNextAt

      public MemorySegment pNextAt(long index)
      Returns pNext at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      pNext at the given index

    • pNextAt

      public VkVideoEncodeRateControlInfoKHR pNextAt(long index, MemorySegment value)
      Sets pNext with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • flagsAt

      public int flagsAt(long index)
      Returns flags at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      flags at the given index

    • flagsAt

      public VkVideoEncodeRateControlInfoKHR flagsAt(long index, int value)
      Sets flags with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • rateControlModeAt

      public int rateControlModeAt(long index)
      Returns rateControlMode at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      rateControlMode at the given index

    • rateControlModeAt

      public VkVideoEncodeRateControlInfoKHR rateControlModeAt(long index, int value)
      Sets rateControlMode with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • layerCountAt

      public int layerCountAt(long index)
      Returns layerCount at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      layerCount at the given index

    • layerCountAt

      public VkVideoEncodeRateControlInfoKHR layerCountAt(long index, int value)
      Sets layerCount with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • pLayersAt

      public MemorySegment pLayersAt(long index)
      Returns pLayers at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      pLayers at the given index

    • pLayersAt

      public VkVideoEncodeRateControlInfoKHR pLayersAt(long index, MemorySegment value)
      Sets pLayers with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • virtualBufferSizeInMsAt

      public int virtualBufferSizeInMsAt(long index)
      Returns virtualBufferSizeInMs at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      virtualBufferSizeInMs at the given index

    • virtualBufferSizeInMsAt

      public VkVideoEncodeRateControlInfoKHR virtualBufferSizeInMsAt(long index, int value)
      Sets virtualBufferSizeInMs with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this

    • initialVirtualBufferSizeInMsAt

      public int initialVirtualBufferSizeInMsAt(long index)
      Returns initialVirtualBufferSizeInMs at the given index.
      Parameters:
      index - the index of the struct buffer
      Returns:
      initialVirtualBufferSizeInMs at the given index

    • initialVirtualBufferSizeInMsAt

      public VkVideoEncodeRateControlInfoKHR initialVirtualBufferSizeInMsAt(long index, int value)
      Sets initialVirtualBufferSizeInMs with the given value at the given index.
      Parameters:
      index - the index of the struct buffer
      value - the value
      Returns:
      this