Enum Class BufferFlags

java.lang.Object

java.lang.Enum<BufferFlags>

org.freedesktop.harfbuzz.BufferFlags

All Implemented Interfaces:

Serializable, Comparable<BufferFlags>, Constable, Enumeration

@Generated("org.javagi.JavaGI")
public enum BufferFlags
extends Enum<BufferFlags>
implements Enumeration

Flags for hb_buffer_t.

Since:

0.9.20

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOT	flag indicating that special handling of the beginning of text paragraph can be applied to this buffer.
DEFAULT	the default buffer flag.
DEFINED	All currently defined flags: Since: 4.4.0
DO_NOT_INSERT_DOTTED_CIRCLE	flag indicating that a dotted circle should not be inserted in the rendering of incorrect character sequences (such at <0905 093E>).
EOT	flag indicating that special handling of the end of text paragraph can be applied to this buffer, similar to HBBUFFERFLAGBOT.
PRESERVE_DEFAULT_IGNORABLES	flag indication that character with Default_Ignorable Unicode property should use the corresponding glyph from the font, instead of hiding them (done by replacing them with the space glyph and zeroing the advance width.) This flag takes precedence over HBBUFFERFLAGREMOVEDEFAULTIGNORABLES.
PRODUCE_SAFE_TO_INSERT_TATWEEL	flag indicating that the HBGLYPHFLAGSAFETOINSERTTATWEEL glyph-flag should be produced by the shaper.
PRODUCE_UNSAFE_TO_CONCAT	flag indicating that the HBGLYPHFLAGUNSAFETOCONCAT glyph-flag should be produced by the shaper.
REMOVE_DEFAULT_IGNORABLES	flag indication that character with Default_Ignorable Unicode property should be removed from glyph string instead of hiding them (done by replacing them with the space glyph and zeroing the advance width.) HBBUFFERFLAGPRESERVEDEFAULTIGNORABLES takes precedence over this flag.
VERIFY	flag indicating that the hb_shape() call and its variants should perform various verification processes on the results of the shaping operation on the buffer.

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the BufferFlags class.
int	getValue()	Get the numeric value of this enum
static Set<BufferFlags>	of(int flags)	Create a new EnumSet<BufferFlags> for the provided bitfield
static Set<BufferFlags>	of(MemorySegment address)	Create a new EnumSet<BufferFlags> for the bitfield in the provided memory address.
static BufferFlags	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BufferFlags[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFAULT

public static final BufferFlags DEFAULT

the default buffer flag.

BOT

public static final BufferFlags BOT

flag indicating that special handling of the beginning of text paragraph can be applied to this buffer. Should usually be set, unless you are passing to the buffer only part of the text without the full context.

EOT

public static final BufferFlags EOT

flag indicating that special handling of the end of text paragraph can be applied to this buffer, similar to HBBUFFERFLAGBOT.

PRESERVE_DEFAULT_IGNORABLES

public static final BufferFlags PRESERVE_DEFAULT_IGNORABLES

flag indication that character with Default_Ignorable Unicode property should use the corresponding glyph from the font, instead of hiding them (done by replacing them with the space glyph and zeroing the advance width.) This flag takes precedence over HBBUFFERFLAGREMOVEDEFAULTIGNORABLES.

REMOVE_DEFAULT_IGNORABLES

public static final BufferFlags REMOVE_DEFAULT_IGNORABLES

flag indication that character with Default_Ignorable Unicode property should be removed from glyph string instead of hiding them (done by replacing them with the space glyph and zeroing the advance width.) HBBUFFERFLAGPRESERVEDEFAULTIGNORABLES takes precedence over this flag. Since: 1.8.0

DO_NOT_INSERT_DOTTED_CIRCLE

public static final BufferFlags DO_NOT_INSERT_DOTTED_CIRCLE

flag indicating that a dotted circle should not be inserted in the rendering of incorrect character sequences (such at <0905 093E>). Since: 2.4.0

VERIFY

public static final BufferFlags VERIFY

flag indicating that the hb_shape() call and its variants should perform various verification processes on the results of the shaping operation on the buffer. If the verification fails, then either a buffer message is sent, if a message handler is installed on the buffer, or a message is written to standard error. In either case, the shaping result might be modified to show the failed output. Since: 3.4.0

PRODUCE_UNSAFE_TO_CONCAT

public static final BufferFlags PRODUCE_UNSAFE_TO_CONCAT

flag indicating that the HBGLYPHFLAGUNSAFETOCONCAT glyph-flag should be produced by the shaper. By default it will not be produced since it incurs a cost. Since: 4.0.0

PRODUCE_SAFE_TO_INSERT_TATWEEL

public static final BufferFlags PRODUCE_SAFE_TO_INSERT_TATWEEL

flag indicating that the HBGLYPHFLAGSAFETOINSERTTATWEEL glyph-flag should be produced by the shaper. By default it will not be produced. Since: 5.1.0

DEFINED

public static final BufferFlags DEFINED

All currently defined flags: Since: 4.4.0

Method Details

values

public static BufferFlags[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static BufferFlags valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

of

public static Set<BufferFlags> of(int flags)

Create a new EnumSet<BufferFlags> for the provided bitfield

Parameters:

flags - the BufferFlags bitfield

Returns:

the EnumSet for the provided bitfield

of

public static Set<BufferFlags> of(MemorySegment address)

Create a new EnumSet<BufferFlags> for the bitfield in the provided memory address.

Parameters:

address - the memory address holding a bitfield value

Returns:

the EnumSet for the bitfield in the provided memory address

getType

public static @Nullable Type getType()

Get the GType of the BufferFlags class.

Returns:

the GType