Modifier and Type	Class and Description
public static enum	CLMemory.GLObjectType
public static enum	CLMemory.Map Configures the mapping process.
public static enum	CLMemory.Mem Memory settings for configuring CLMemory.

Modifier and Type	Field and Description
private final CLMemObjBinding	binding
pack-priv B	buffer
protected int	clCapacity
protected int	elementSize
protected final int	FLAGS
protected long	size

Access	Constructor and Description
protected <Buffer>	CLMemory(final CLContext context, final long size, final long id, final int flags)
protected	CLMemory(final CLContext context, final B directBuffer, final long size, final long id, final int flags)

Method Summary

Modifier and Type	Method and Description
public abstract <T extends Buffer> CLMemory<T>	cloneWith(T directBuffer) Returns a new instance of CLMemory pointing to the same CLResource but using a different Buffer.
public boolean	equals(final Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Returns the OpenGL buffer type of this shared buffer.
public B	getBuffer() Returns the optional NIO buffer for this memory object.
protected static CL	getCL(final CLContext context)
public int	getCLCapacity() Returns the size in buffer elements of this memory object.
public long	getCLSize() Returns the size of the allocated OpenCL memory in bytes.
public EnumSet<CLMemory.Mem>	getConfig() Returns the configuration of this memory object.
public int	getElementSize() Returns the size in bytes of a single buffer element.
public int	getMapCount() Returns the number of buffer mappings.
public int	getNIOCapacity() Returns the capacity of the wrapped direct buffer or 0 if no buffer available.
public int	getNIOSize() Returns the size of the wrapped direct buffer in byte or 0 if no buffer available.
protected static long	getSizeImpl(final CLContext context, final long id)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
protected final void	initCLCapacity()
private void	initElementSize()
protected static boolean	isHostPointerFlag(final int flags) Returns true if a host pointer must be specified on mem object creation.
public boolean	isReadOnly() Returns true if this memory object was created with the `Mem#READ_ONLY` flag.
public boolean	isReadWrite() Returns true if this memory object was created with the `Mem#READ_WRITE` flag.
public boolean	isWriteOnly() Returns true if this memory object was created with the `Mem#WRITE_ONLY` flag.
public void	registerDestructorCallback(final CLMemObjectListener listener) Registers a callback which will be called by the OpenCL implementation when the memory object is released.
public void	release() Overrides com.jogamp.opencl.CLObjectResource.release. Implements com.jogamp.opencl.CLResource.release. Releases the OpenCL resource.
public String	toString() Overrides com.jogamp.opencl.CLObject.toString. Returns a string representation of the object.
public CLMemory<B>	use(final B buffer)

Inherited from com.jogamp.opencl.CLObjectResource:: close isReleased

Field Detail

binding	back to summary
private final CLMemObjBinding binding

buffer	back to summary
pack-priv B buffer

clCapacity	back to summary
protected int clCapacity

elementSize	back to summary
protected int elementSize

FLAGS	back to summary
protected final int FLAGS

size	back to summary
protected long size

Constructor Detail

CLMemory	back to summary
protected <Buffer> CLMemory(final CLContext context, final long size, final long id, final int flags)

CLMemory	back to summary
protected CLMemory(final CLContext context, final B directBuffer, final long size, final long id, final int flags)

Method Detail

cloneWith	back to summary
public abstract <T extends Buffer> CLMemory<T> cloneWith(T directBuffer) Returns a new instance of CLMemory pointing to the same CLResource but using a different Buffer.

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. Returns the OpenGL buffer type of this shared buffer. Parameters obj:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Returns the OpenGL buffer type of this shared buffer.

Parameters

obj:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getBuffer	back to summary
public B getBuffer() Returns the optional NIO buffer for this memory object.

getCL	back to summary
protected static CL getCL(final CLContext context)

getCLCapacity	back to summary
public int getCLCapacity() Returns the size in buffer elements of this memory object.

getCLSize	back to summary
public long getCLSize() Returns the size of the allocated OpenCL memory in bytes.

getConfig	back to summary
public EnumSet<CLMemory.Mem> getConfig() Returns the configuration of this memory object.

getElementSize	back to summary
public int getElementSize() Returns the size in bytes of a single buffer element. This method returns 1 if no buffer is available indicating regular byte access.

getMapCount	back to summary
public int getMapCount() Returns the number of buffer mappings. The map count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for debugging.

getNIOCapacity	back to summary
public int getNIOCapacity() Returns the capacity of the wrapped direct buffer or 0 if no buffer available.

getNIOSize	back to summary
public int getNIOSize() Returns the size of the wrapped direct buffer in byte or 0 if no buffer available.

getSizeImpl	back to summary
protected static long getSizeImpl(final CLContext context, final long id)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

initCLCapacity	back to summary
protected final void initCLCapacity()

initElementSize	back to summary
private void initElementSize()

isHostPointerFlag	back to summary
protected static boolean isHostPointerFlag(final int flags) Returns true if a host pointer must be specified on mem object creation.

isReadOnly	back to summary
public boolean isReadOnly() Returns true if this memory object was created with the `Mem#READ_ONLY` flag.

isReadWrite	back to summary
public boolean isReadWrite() Returns true if this memory object was created with the `Mem#READ_WRITE` flag.

isWriteOnly	back to summary
public boolean isWriteOnly() Returns true if this memory object was created with the `Mem#WRITE_ONLY` flag.

registerDestructorCallback	back to summary
public void registerDestructorCallback(final CLMemObjectListener listener) Registers a callback which will be called by the OpenCL implementation when the memory object is released.

release	back to summary
public void release() Overrides com.jogamp.opencl.CLObjectResource.release. Implements com.jogamp.opencl.CLResource.release. Doc from com.jogamp.opencl.CLResource.release. Releases the OpenCL resource. Annotations @Override

release

back to summary

public void release()

Overrides com.jogamp.opencl.CLObjectResource.release.

Implements com.jogamp.opencl.CLResource.release.

Doc from com.jogamp.opencl.CLResource.release.

Releases the OpenCL resource.

Annotations

@Override

toString	back to summary
public String toString() Overrides com.jogamp.opencl.CLObject.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides com.jogamp.opencl.CLObject.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

use	back to summary
public CLMemory<B> use(final B buffer)

com.jogamp.opencl back to summary

public final Enum CLMemory.GLObjectType

Class Inheritance

extends Enum<CLMemory.GLObjectType>

java.lang.Object
java.lang.Enum
com.jogamp.opencl.CLMemory.GLObjectType

Field Summary

Modifier and Type	Field and Description
public static final CLMemory.GLObjectType	GL_OBJECT_BUFFER
public static final CLMemory.GLObjectType	GL_OBJECT_RENDERBUFFER
public static final CLMemory.GLObjectType	GL_OBJECT_TEXTURE2D
public static final CLMemory.GLObjectType	GL_OBJECT_TEXTURE3D
public final int	TYPE

Constructor Summary

Access	Constructor and Description
private	GLObjectType(final int type)

Method Summary

Modifier and Type	Method and Description
public static CLMemory.GLObjectType	valueOf(String name)
public static CLMemory.GLObjectType	valueOf(final int type)
public static CLMemory.GLObjectType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

GL_OBJECT_BUFFER	back to summary
public static final CLMemory.GLObjectType GL_OBJECT_BUFFER

GL_OBJECT_RENDERBUFFER	back to summary
public static final CLMemory.GLObjectType GL_OBJECT_RENDERBUFFER

GL_OBJECT_TEXTURE2D	back to summary
public static final CLMemory.GLObjectType GL_OBJECT_TEXTURE2D

GL_OBJECT_TEXTURE3D	back to summary
public static final CLMemory.GLObjectType GL_OBJECT_TEXTURE3D

TYPE	back to summary
public final int TYPE

Constructor Detail

GLObjectType	back to summary
private GLObjectType(final int type)

Method Detail

valueOf	back to summary
public static CLMemory.GLObjectType valueOf(String name)

valueOf	back to summary
public static CLMemory.GLObjectType valueOf(final int type)

values	back to summary
public static CLMemory.GLObjectType[] values()

com.jogamp.opencl back to summary

public final Enum CLMemory.Map

Class Inheritance

extends Enum<CLMemory.Map>

java.lang.Object
java.lang.Enum
com.jogamp.opencl.CLMemory.Map

Configures the mapping process.

See Also: com.jogamp.opencl.CLCommandQueue#putMapBuffer(CLBuffer, com.jogamp.opencl.CLMemory.Map, boolean)., com.jogamp.opencl.CLCommandQueue#putMapImage(CLImage2d, com.jogamp.opencl.CLMemory.Map, boolean), com.jogamp.opencl.CLCommandQueue#putMapImage(CLImage3d, com.jogamp.opencl.CLMemory.Map, boolean)

Field Summary

Modifier and Type	Field and Description
public final int	FLAGS Value of wrapped OpenCL flag.
public static final CLMemory.Map	READ Enum representing CL_MAP_READ.
public static final CLMemory.Map	READ_WRITE Enum representing CL_MAP_READ \| CL_MAP_WRITE.
public static final CLMemory.Map	WRITE Enum representing CL_MAP_WRITE.

Constructor Summary

Access	Constructor and Description
private	Map(final int flags)

Method Summary

Modifier and Type	Method and Description
public static CLMemory.Map	valueOf(String name)
public CLMemory.Map	valueOf(final int flag)
public static CLMemory.Map[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

FLAGS	back to summary
public final int FLAGS Value of wrapped OpenCL flag.

READ	back to summary
public static final CLMemory.Map READ Enum representing CL_MAP_READ. This flag specifies that the memory object will be mapped for read operation.

READ_WRITE	back to summary
public static final CLMemory.Map READ_WRITE Enum representing CL_MAP_READ \| CL_MAP_WRITE. This flag specifies that the memory object will be mapped for read and write operation.

WRITE	back to summary
public static final CLMemory.Map WRITE Enum representing CL_MAP_WRITE. This flag specifies that the memory object will be mapped for write operation.

Constructor Detail

Map	back to summary
private Map(final int flags)

Method Detail

valueOf	back to summary
public static CLMemory.Map valueOf(String name)

valueOf	back to summary
public CLMemory.Map valueOf(final int flag)

values	back to summary
public static CLMemory.Map[] values()

com.jogamp.opencl back to summary

public final Enum CLMemory.Mem

Class Inheritance

extends Enum<CLMemory.Mem>

java.lang.Object
java.lang.Enum
com.jogamp.opencl.CLMemory.Mem

Memory settings for configuring CLMemory.

Field Summary

Modifier and Type	Field and Description
public static final CLMemory.Mem	ALLOCATE_BUFFER Enum representing CL_MEM_ALLOC_HOST_PTR.
public final int	CONFIG Value of wrapped OpenCL flag.
public static final CLMemory.Mem	COPY_BUFFER Enum representing CL_MEM_COPY_HOST_PTR.
public static final CLMemory.Mem	READ_ONLY Enum representing CL_MEM_READ_ONLY.
public static final CLMemory.Mem	READ_WRITE Enum representing CL_MEM_READ_WRITE.
public static final CLMemory.Mem	USE_BUFFER Enum representing CL_MEM_USE_HOST_PTR.
public static final CLMemory.Mem	WRITE_ONLY Enum representing CL_MEM_WRITE_ONLY.

Constructor Summary

Access	Constructor and Description
private	Mem(final int config)

Method Summary

Modifier and Type	Method and Description
public static int	flagsToInt(final CLMemory.Mem[] flags)
public static CLMemory.Mem	valueOf(String name)
public static CLMemory.Mem	valueOf(final int bufferFlag)
public static CLMemory.Mem[]	values()
public static EnumSet<CLMemory.Mem>	valuesOf(final int bitfield)

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ALLOCATE_BUFFER	back to summary
public static final CLMemory.Mem ALLOCATE_BUFFER Enum representing CL_MEM_ALLOC_HOST_PTR. This flag specifies that the application wants the OpenCL implementation to allocate memory from host accessible memory. `ALLOCATE_BUFFER` and `USE_BUFFER` are mutually exclusive.

CONFIG	back to summary
public final int CONFIG Value of wrapped OpenCL flag.

COPY_BUFFER	back to summary
public static final CLMemory.Mem COPY_BUFFER Enum representing CL_MEM_COPY_HOST_PTR. If `COPY_BUFFER` specified, it indicates that the application wants the OpenCL implementation to allocate memory for the memory object and copy the data from memory referenced by host_ptr. `COPY_BUFFER` and `USE_BUFFER` are mutually exclusive.

READ_ONLY	back to summary
public static final CLMemory.Mem READ_ONLY Enum representing CL_MEM_READ_ONLY. This flag specifies that the memory object is a read-only memory object when used inside a kernel. Writing to a buffer or image object created withREAD_ONLY inside a kernel is undefined.

READ_WRITE	back to summary
public static final CLMemory.Mem READ_WRITE Enum representing CL_MEM_READ_WRITE. This flag specifies that the memory object will be read and written by a kernel.

USE_BUFFER

back to summary

public static final CLMemory.Mem USE_BUFFER

Enum representing CL_MEM_USE_HOST_PTR. If specified, it indicates that the application wants the OpenCL implementation to use memory referenced by host_ptr as the storage bits for the memory object. OpenCL implementations are allowed to cache the buffer contents pointed to by host_ptr in device memory. This cached copy can be used when kernels are executed on a device.

WRITE_ONLY	back to summary
public static final CLMemory.Mem WRITE_ONLY Enum representing CL_MEM_WRITE_ONLY. This flags specifies that the memory object will be written but not read by a kernel. Reading from a buffer or image object created with WRITE_ONLY inside a kernel is undefined.

Constructor Detail

Mem	back to summary
private Mem(final int config)

Method Detail

flagsToInt	back to summary
public static int flagsToInt(final CLMemory.Mem[] flags)

valueOf	back to summary
public static CLMemory.Mem valueOf(String name)

valueOf	back to summary
public static CLMemory.Mem valueOf(final int bufferFlag)

values	back to summary
public static CLMemory.Mem[] values()

valuesOf	back to summary
public static EnumSet<CLMemory.Mem> valuesOf(final int bitfield)

public abstract Class CLMemory<B extends Buffer>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum CLMemory.GLObjectType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum CLMemory.Map

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum CLMemory.Mem

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail