Package org.lwjgl.util.zstd

Class ZSTDCustomMem

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class ZSTDCustomMem
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

    Layout

    
 struct ZSTD_customMem {
     ZSTD_allocFunction customAlloc;
     ZSTD_freeFunction customFree;
     void * opaque;
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • CUSTOMALLOC, CUSTOMFREE, OPAQUE

        The struct member offsets.

    • Constructor Detail

      • ZSTDCustomMem

        public ZSTDCustomMem​(java.nio.ByteBuffer container)
        Creates a ZSTDCustomMem 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 Detail

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct

      • customAlloc

        public ZSTDAllocFunction customAlloc()
        Returns the value of the customAlloc field.

      • customFree

        public ZSTDFreeFunction customFree()
        Returns the value of the customFree field.

      • opaque

        public long opaque()
        Returns the value of the opaque field.

      • opaque

        public ZSTDCustomMem opaque​(long value)
        Sets the specified value to the opaque field.

      • set

        public ZSTDCustomMem set​(ZSTDCustomMem src)
        Copies the specified struct data to this struct.
        Parameters:
        src - the source struct
        Returns:
        this struct

      • malloc

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

      • calloc

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

      • create

        public static ZSTDCustomMem create​(long address)
        Returns a new ZSTDCustomMem instance for the specified memory address.

      • createSafe

        @Nullable
public static ZSTDCustomMem createSafe​(long address)
        Like create, but returns null if address is NULL.

      • malloc

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

      • calloc

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

      • create

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

      • createSafe

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

      • mallocStack

        public static ZSTDCustomMem mallocStack()
        Returns a new ZSTDCustomMem instance allocated on the thread-local MemoryStack.

      • callocStack

        public static ZSTDCustomMem callocStack()
        Returns a new ZSTDCustomMem instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

      • mallocStack

        public static ZSTDCustomMem mallocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new ZSTDCustomMem instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate

      • callocStack

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

      • mallocStack

        public static ZSTDCustomMem.Buffer mallocStack​(int capacity)
        Returns a new ZSTDCustomMem.Buffer instance allocated on the thread-local MemoryStack.
        Parameters:
        capacity - the buffer capacity

      • callocStack

        public static ZSTDCustomMem.Buffer callocStack​(int capacity)
        Returns a new ZSTDCustomMem.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
        Parameters:
        capacity - the buffer capacity

      • mallocStack

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

      • callocStack

        public static ZSTDCustomMem.Buffer callocStack​(int capacity,
                                               org.lwjgl.system.MemoryStack stack)
        Returns a new ZSTDCustomMem.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • nopaque

        public static long nopaque​(long struct)
        Unsafe version of opaque().

      • nopaque

        public static void nopaque​(long struct,
                           long value)
        Unsafe version of opaque.

      • validate

        public static void validate​(long struct)
        Validates pointer members that should not be NULL.
        Parameters:
        struct - the struct to validate

      • validate

        public static void validate​(long array,
                            int count)
        Calls validate(long) for each struct contained in the specified struct array.
        Parameters:
        array - the struct array to validate
        count - the number of structs in array