Package org.freedesktop.gstreamer.gst

Enum Class MemoryFlags

java.lang.Object

java.lang.Enum<MemoryFlags>

org.freedesktop.gstreamer.gst.MemoryFlags

All Implemented Interfaces:

Serializable, Comparable<MemoryFlags>, Constable, Enumeration

@Generated("io.github.jwharm.JavaGI")
public enum MemoryFlags
extends Enum<MemoryFlags>
implements Enumeration

Flags for wrapped memory.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LAST	first flag that can be used for custom purposes
NO_SHARE	memory must not be shared.
NOT_MAPPABLE	the memory can't be mapped via gst_memory_map() without any preconditions.
PHYSICALLY_CONTIGUOUS	the memory is physically contiguous.
READONLY	memory is readonly.
ZERO_PADDED	the memory padding is filled with 0 bytes
ZERO_PREFIXED	the memory prefix is filled with 0 bytes

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

READONLY

public static final MemoryFlags READONLY

memory is readonly. It is not allowed to map the memory with GST_MAP_WRITE.

NO_SHARE

public static final MemoryFlags NO_SHARE

memory must not be shared. Copies will have to be made when this memory needs to be shared between buffers. (DEPRECATED: do not use in new code, instead you should create a custom GstAllocator for memory pooling instead of relying on the GstBuffer they were originally attached to.)

ZERO_PREFIXED

public static final MemoryFlags ZERO_PREFIXED

the memory prefix is filled with 0 bytes

ZERO_PADDED

public static final MemoryFlags ZERO_PADDED

the memory padding is filled with 0 bytes

PHYSICALLY_CONTIGUOUS

public static final MemoryFlags PHYSICALLY_CONTIGUOUS

the memory is physically contiguous. (Since: 1.2)

NOT_MAPPABLE

public static final MemoryFlags NOT_MAPPABLE

the memory can't be mapped via gst_memory_map() without any preconditions. (Since: 1.2)

LAST

public static final MemoryFlags LAST

first flag that can be used for custom purposes

Method Details

values

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

Create a new EnumSet<MemoryFlags> for the provided bitfield

Parameters:

flags - the MemoryFlags bitfield

Returns:

the EnumSet for the provided bitfield

of

public static Set<MemoryFlags> of(MemorySegment address)

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

Returns:

the GType