Package org.lwjgl.opencl

Class CLMemEXTHostPtr

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

    public class CLMemEXTHostPtr
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Accepted by the host_ptr argument of CreateBuffer, CreateImage2D and CreateImage3D.

    Member documentation

    • allocation_type – type of external memory allocation. Legal values will be defined in layered extensions.
    • host_cache_policy – host cache policy for this external memory allocation

    Layout

     struct cl_mem_ext_host_ptr {
     cl_uint allocation_type;
     cl_uint host_cache_policy;
 }

    • Field Detail

      • SIZEOF

        public static final int SIZEOF
        The struct size in bytes.

    • Constructor Detail

      • CLMemEXTHostPtr

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

      • allocation_type

        public int allocation_type()
        Returns the value of the allocation_type field.

      • host_cache_policy

        public int host_cache_policy()
        Returns the value of the host_cache_policy field.

      • allocation_type

        public CLMemEXTHostPtr allocation_type(int value)
        Sets the specified value to the allocation_type field.

      • host_cache_policy

        public CLMemEXTHostPtr host_cache_policy(int value)
        Sets the specified value to the host_cache_policy field.

      • set

        public CLMemEXTHostPtr set(int allocation_type,
                           int host_cache_policy)
        Initializes this struct with the specified values.

      • set

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

      • malloc

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

      • calloc

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

      • createSafe

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

      • malloc

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

      • calloc

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

      • create

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

      • createSafe

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

      • callocStack

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

      • mallocStack

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

      • callocStack

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

      • callocStack

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

      • mallocStack

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

      • callocStack

        public static CLMemEXTHostPtr.Buffer callocStack(int capacity,
                                                 org.lwjgl.system.MemoryStack stack)
        Returns a new CLMemEXTHostPtr.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