Class ValueList

All Implemented Interfaces:
Proxy

@Generated("org.javagi.JavaGI") public class ValueList extends TypeInstance
A fundamental type that describes an unordered list of GValue
  • Constructor Details

    • ValueList

      public ValueList(MemorySegment address)
      Create a ValueList instance for the provided memory address.
      Parameters:
      address - the memory address of the native object
  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the ValueList class.
      Returns:
      the GType
    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout
    • asParent

      protected ValueList asParent()
      Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.
      Returns:
      the instance as if it were its parent type
    • appendAndTakeValue

      public static void appendAndTakeValue(Value value, Value appendValue)
      Appends appendValue to the GstValueList in value.
      Parameters:
      value - a GValue of type GST_TYPE_LIST
      appendValue - the value to append
      Since:
      1.2
    • appendValue

      public static void appendValue(Value value, Value appendValue)
      Appends appendValue to the GstValueList in value.
      Parameters:
      value - a GValue of type GST_TYPE_LIST
      appendValue - the value to append
    • concat

      public static void concat(Value dest, Value value1, Value value2)
      Concatenates copies of value1 and value2 into a list. Values that are not of type GST_TYPE_LIST are treated as if they were lists of length 1. dest will be initialized to the type GST_TYPE_LIST.
      Parameters:
      dest - an uninitialized GValue to take the result
      value1 - a GValue
      value2 - a GValue
    • getSize

      public static int getSize(Value value)
      Gets the number of values contained in value.
      Parameters:
      value - a GValue of type GST_TYPE_LIST
      Returns:
      the number of values
    • getValue

      public static Value getValue(Value value, int index)
      Gets the value that is a member of the list contained in value and has the index index.
      Parameters:
      value - a GValue of type GST_TYPE_LIST
      index - index of value to get from the list
      Returns:
      the value at the given index
    • init

      public static Value init(Value value, int prealloc)
      Initializes and pre-allocates a GValue of type GST_TYPE_LIST.
      Parameters:
      value - A zero-filled (uninitialized) GValue structure
      prealloc - The number of entries to pre-allocate in the list
      Returns:
      The GValue structure that has been passed in
      Since:
      1.18
    • merge

      public static void merge(Value dest, Value value1, Value value2)

      Merges copies of value1 and value2. Values that are not of type GST_TYPE_LIST are treated as if they were lists of length 1.

      The result will be put into dest and will either be a list that will not contain any duplicates, or a non-list type (if value1 and value2 were equal).

      Parameters:
      dest - an uninitialized GValue to take the result
      value1 - a GValue
      value2 - a GValue
    • prependValue

      public static void prependValue(Value value, Value prependValue)
      Prepends prependValue to the GstValueList in value.
      Parameters:
      value - a GValue of type GST_TYPE_LIST
      prependValue - the value to prepend