Class CLMemEXTHostPtr

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

    public class CLMemEXTHostPtr
    extends Struct
    implements 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

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • ALLOCATION_TYPE, HOST_CACHE_POLICY

        The struct member offsets.
    • 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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class 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.
      • create

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

        @Nullable
        public static CLMemEXTHostPtr createSafe​(long address)
        Like create, but returns null if address is NULL.
      • 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.
      • mallocStack

        public static CLMemEXTHostPtr mallocStack()
        Returns a new CLMemEXTHostPtr instance allocated on the thread-local MemoryStack.
      • 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​(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​(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
      • nallocation_type

        public static int nallocation_type​(long struct)
        Unsafe version of allocation_type().
      • nhost_cache_policy

        public static int nhost_cache_policy​(long struct)
        Unsafe version of host_cache_policy().
      • nallocation_type

        public static void nallocation_type​(long struct,
                                            int value)
        Unsafe version of allocation_type.
      • nhost_cache_policy

        public static void nhost_cache_policy​(long struct,
                                              int value)
        Unsafe version of host_cache_policy.