java.com.jogamp.opencl.llb.CLMemObjBinding Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jocl Show documentation
Java™ Binding for the OpenCL® API
There is a newer version: 2.3.2
/* !---- DO NOT EDIT: This file autogenerated by com/jogamp/gluegen/JavaEmitter.java on Fri Jan 31 16:37:39 CET 2014 ----! */

package com.jogamp.opencl.llb;

import com.jogamp.opencl.llb.impl.CLMemObjectDestructorCallback;
import com.jogamp.gluegen.runtime.*;
import com.jogamp.common.os.*;
import com.jogamp.common.nio.*;
import java.nio.*;

 /**
  * Java bindings to OpenCL memory objects.
  * @author Michael Bien, GlueGen, et al.
  */
public interface CLMemObjBinding {

  public static final int CL_MEM_OBJECT_ALLOCATION_FAILURE = -4;
  public static final int CL_MEM_COPY_OVERLAP = -8;
  public static final int CL_MAP_FAILURE = -12;
  public static final int CL_MEM_READ_WRITE = (1<<0);
  public static final int CL_MEM_WRITE_ONLY = (1<<1);
  public static final int CL_MEM_READ_ONLY = (1<<2);
  public static final int CL_MEM_USE_HOST_PTR = (1<<3);
  public static final int CL_MEM_ALLOC_HOST_PTR = (1<<4);
  public static final int CL_MEM_COPY_HOST_PTR = (1<<5);
  public static final int CL_MEM_OBJECT_BUFFER = 0x10F0;
  public static final int CL_MEM_OBJECT_IMAGE2D = 0x10F1;
  public static final int CL_MEM_OBJECT_IMAGE3D = 0x10F2;
  public static final int CL_MEM_TYPE = 0x1100;
  public static final int CL_MEM_FLAGS = 0x1101;
  public static final int CL_MEM_SIZE = 0x1102;
  public static final int CL_MEM_HOST_PTR = 0x1103;
  public static final int CL_MEM_MAP_COUNT = 0x1104;
  public static final int CL_MEM_REFERENCE_COUNT = 0x1105;
  public static final int CL_MEM_CONTEXT = 0x1106;
  public static final int CL_MEM_ASSOCIATED_MEMOBJECT = 0x1107;
  public static final int CL_MEM_OFFSET = 0x1108;
  public static final int CL_MAP_READ = (1<<0);
  public static final int CL_MAP_WRITE = (1<<1);

  /** Interface to C language function: 
  cl_int {@native clGetMemObjectInfo}(cl_mem memobj, cl_mem_info param_name, size_t param_value_size, void *  param_value, size_t *  param_value_size_ret);  
      @param param_value a direct only {@link java.nio.Buffer}
      @param param_value_size_ret a direct only {@link com.jogamp.common.nio.PointerBuffer}   */
  public int clGetMemObjectInfo(long memobj, int param_name, long param_value_size, Buffer param_value, PointerBuffer param_value_size_ret);

  /** Interface to C language function: 
  cl_int {@native clReleaseMemObject}(cl_mem memobj);     */
  public int clReleaseMemObject(long memobj);

  /** Interface to C language function: 
  cl_int {@native clRetainMemObject}(cl_mem memobj);     */
  public int clRetainMemObject(long memobj);


  // --- Begin CustomJavaCode .cfg declarations

  /** Interface to C language function: 
  int32_t {@native clSetMemObjectDestructorCallback}(cl_mem memobj, void (CL_CALLBACK  *pfn_notify) (cl_mem memobj, void *user_data), void *user_data);     */
  public int clSetMemObjectDestructorCallback(long memObjID, CLMemObjectDestructorCallback cb);
  // ---- End CustomJavaCode .cfg declarations

} // end of class CLMemObjBinding