org.freedesktop.gstreamer.gst.AllocatorFlags Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gst Show documentation
Java language bindings for Gst, generated with Java-GI
There is a newer version: 0.10.2
// Java-GI - Java language bindings for GObject-Introspection-based libraries
// Copyright (C) 2022-2024 Jan-Willem Harmannij
//
// SPDX-License-Identifier: LGPL-2.1-or-later
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, see .
//
// This file has been generated with Java-GI.
// Do not edit this file directly!
// Visit  for more information.
//
package org.freedesktop.gstreamer.gst;

import io.github.jwharm.javagi.base.Enumeration;
import io.github.jwharm.javagi.interop.Interop;
import java.lang.IllegalStateException;
import java.lang.Override;
import javax.annotation.processing.Generated;
import org.gnome.glib.Type;

/**
 * Flags for allocators.
 */
@Generated("io.github.jwharm.JavaGI")
public enum AllocatorFlags implements Enumeration {
    /**
     * 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 {@link org.freedesktop.gstreamer.gst.AllocatorFlags#NO_COPY}.
     */
    CUSTOM_ALLOC(16),

    /**
     * When copying a {@code 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
     * {@code GstBufferPool} for example.
     */
    NO_COPY(32),

    /**
     * first flag that can be used for custom purposes
     */
    LAST(1048576);

    static {
        Gst.javagi$ensureInitialized();
    }

    private final int value;

    /**
     * Create a new AllocatorFlags for the provided value
     *
     * @param value the bitfield value
     */
    private AllocatorFlags(int value) {
        this.value = value;
    }

    /**
     * Create a new AllocatorFlags for the provided value
     *
     * @param value the bitfield value
     * @return the bitfield for the provided value
     */
    public static AllocatorFlags of(int value) {
        return switch(value) {
            case 16 -> CUSTOM_ALLOC;
            case 32 -> NO_COPY;
            case 1048576 -> LAST;
            default -> throw new IllegalStateException("Unexpected value: " + value);
        } ;
    }

    /**
     * Get the numeric value of this enum
     *
     * @return the enum value
     */
    @Override
    public int getValue() {
        return value;
    }

    /**
     * Get the GType of the AllocatorFlags class
     *
     * @return the GType
     */
    public static Type getType() {
        return Interop.getType("gst_allocator_flags_get_type");
    }
}