Class hb_feature_t

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<hb_feature_t>
org.lwjgl.util.harfbuzz.hb_feature_t
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class hb_feature_t extends org.lwjgl.system.Struct<hb_feature_t> implements org.lwjgl.system.NativeResource
The structure that holds information about requested feature application.

The feature will be applied with the given value to all glyphs which are in clusters between start (inclusive) and end (exclusive). Setting start to FEATURE_GLOBAL_START and end to FEATURE_GLOBAL_END specifies that the feature always applies to the entire buffer.

Layout


 struct hb_feature_t {
     hb_tag_t tag();
     uint32_t value();
     unsigned int start();
     unsigned int end();
 }
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    An array of hb_feature_t structs.

    Nested classes/interfaces inherited from class org.lwjgl.system.Struct

    org.lwjgl.system.Struct.StructValidation

    Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

    org.lwjgl.system.Pointer.Default
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    The struct alignment in bytes.
    static final int
    The struct member offsets.
    static final int
    The struct size in bytes.
    static final int
    The struct member offsets.
    static final int
    The struct member offsets.
    static final int
    The struct member offsets.

    Fields inherited from interface org.lwjgl.system.Pointer

    BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates a hb_feature_t instance at the current position of the specified ByteBuffer container.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns a new hb_feature_t instance allocated with memCalloc.
    calloc(int capacity)
    Returns a new hb_feature_t.Buffer instance allocated with memCalloc.
    calloc(int capacity, org.lwjgl.system.MemoryStack stack)
    Returns a new hb_feature_t.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    calloc(org.lwjgl.system.MemoryStack stack)
    Returns a new hb_feature_t instance allocated on the specified MemoryStack and initializes all its bits to zero.
    Returns a new hb_feature_t instance allocated with BufferUtils.
    create(int capacity)
    Returns a new hb_feature_t.Buffer instance allocated with BufferUtils.
    create(long address)
    Returns a new hb_feature_t instance for the specified memory address.
    create(long address, int capacity)
    Create a hb_feature_t.Buffer instance at the specified memory.
    static @Nullable hb_feature_t
    createSafe(long address)
    Like create, but returns null if address is NULL.
    static @Nullable hb_feature_t.Buffer
    createSafe(long address, int capacity)
    Like create, but returns null if address is NULL.
    int
    end()
    the cluster to end applying this feature setting (exclusive).
    end(int value)
    Sets the specified value to the end() field.
    Returns a new hb_feature_t instance allocated with memAlloc.
    malloc(int capacity)
    Returns a new hb_feature_t.Buffer instance allocated with memAlloc.
    malloc(int capacity, org.lwjgl.system.MemoryStack stack)
    Returns a new hb_feature_t.Buffer instance allocated on the specified MemoryStack.
    malloc(org.lwjgl.system.MemoryStack stack)
    Returns a new hb_feature_t instance allocated on the specified MemoryStack.
    static int
    nend(long struct)
    Unsafe version of end().
    static void
    nend(long struct, int value)
    Unsafe version of end.
    static int
    nstart(long struct)
    Unsafe version of start().
    static void
    nstart(long struct, int value)
    Unsafe version of start.
    static int
    ntag(long struct)
    Unsafe version of tag().
    static void
    ntag(long struct, int value)
    Unsafe version of tag.
    static int
    nvalue(long struct)
    Unsafe version of value().
    static void
    nvalue(long struct, int value)
    Unsafe version of value.
    set(int tag, int value, int start, int end)
    Initializes this struct with the specified values.
    Copies the specified struct data to this struct.
    int
     
    int
    the cluster to start applying this feature setting (inclusive)
    start(int value)
    Sets the specified value to the start() field.
    int
    tag()
    the hb_tag_t tag of the feature
    tag(int value)
    Sets the specified value to the tag() field.
    int
    The value of the feature.
    value(int value)
    Sets the specified value to the value() field.

    Methods inherited from class org.lwjgl.system.Struct

    clear, free, isNull, validate, validate

    Methods inherited from class org.lwjgl.system.Pointer.Default

    address, equals, hashCode, toString

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.lwjgl.system.NativeResource

    close, free
  • Field Details

    • SIZEOF

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

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

      public static final int TAG
      The struct member offsets.
    • VALUE

      public static final int VALUE
      The struct member offsets.
    • START

      public static final int START
      The struct member offsets.
    • END

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

    • hb_feature_t

      public hb_feature_t(ByteBuffer container)
      Creates a hb_feature_t 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()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<hb_feature_t>
    • tag

      public int tag()
      the hb_tag_t tag of the feature
    • value

      public int value()
      The value of the feature.

      0 disables the feature, non-zero (usually 1) enables the feature. For features implemented as lookup type 3 (like 'salt') the value is a one based index into the alternates.

    • start

      public int start()
      the cluster to start applying this feature setting (inclusive)
    • end

      public int end()
      the cluster to end applying this feature setting (exclusive).
    • tag

      public hb_feature_t tag(int value)
      Sets the specified value to the tag() field.
    • value

      public hb_feature_t value(int value)
      Sets the specified value to the value() field.
    • start

      public hb_feature_t start(int value)
      Sets the specified value to the start() field.
    • end

      public hb_feature_t end(int value)
      Sets the specified value to the end() field.
    • set

      public hb_feature_t set(int tag, int value, int start, int end)
      Initializes this struct with the specified values.
    • set

      public hb_feature_t set(hb_feature_t src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct
    • malloc

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

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

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

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

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

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

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

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

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

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

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

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

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

      public static hb_feature_t.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new hb_feature_t.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
    • ntag

      public static int ntag(long struct)
      Unsafe version of tag().
    • nvalue

      public static int nvalue(long struct)
      Unsafe version of value().
    • nstart

      public static int nstart(long struct)
      Unsafe version of start().
    • nend

      public static int nend(long struct)
      Unsafe version of end().
    • ntag

      public static void ntag(long struct, int value)
      Unsafe version of tag.
    • nvalue

      public static void nvalue(long struct, int value)
      Unsafe version of value.
    • nstart

      public static void nstart(long struct, int value)
      Unsafe version of start.
    • nend

      public static void nend(long struct, int value)
      Unsafe version of end.