Enum Class AllocatorFlags

java.lang.Object

java.lang.Enum<AllocatorFlags>

org.freedesktop.gstreamer.gst.AllocatorFlags

All Implemented Interfaces:

Serializable, Comparable<AllocatorFlags>, Constable, Enumeration

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

Flags for allocators.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CUSTOM_ALLOC	The allocator has a custom alloc function.
LAST	first flag that can be used for custom purposes
NO_COPY	When copying a GstMemory allocated with this allocator, the copy will instead be allocated using the default allocator.

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the AllocatorFlags class.
int	getValue()	Get the numeric value of this enum
static Set<AllocatorFlags>	of(int flags)	Create a new EnumSet<AllocatorFlags> for the provided bitfield
static Set<AllocatorFlags>	of(MemorySegment address)	Create a new EnumSet<AllocatorFlags> for the bitfield in the provided memory address.
static AllocatorFlags	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AllocatorFlags[]	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

CUSTOM_ALLOC

public static final AllocatorFlags CUSTOM_ALLOC

The allocator has a custom alloc function. Only elements designed to work with this allocator should be using it, other elements should ignore it from allocation propositions. This implies NO_COPY.

NO_COPY

public static final AllocatorFlags NO_COPY

When copying a GstMemory allocated with this allocator, the copy will instead be allocated using the default allocator. Use this when allocating a new memory is an heavy opperation that should only be done with a GstBufferPool for example.

Since:

1.24

LAST

public static final AllocatorFlags LAST

first flag that can be used for custom purposes

Method Details

values

public static AllocatorFlags[] 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 AllocatorFlags 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<AllocatorFlags> of(int flags)

Create a new EnumSet<AllocatorFlags> for the provided bitfield

Parameters:

flags - the AllocatorFlags bitfield

Returns:

the EnumSet for the provided bitfield

of

public static Set<AllocatorFlags> of(MemorySegment address)

Create a new EnumSet<AllocatorFlags> 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 AllocatorFlags class.

Returns:

the GType