Lighweight Java Game Library 2.9.3 · org.lwjgl.opencl.CLContext

Modifier and Type	Class and Description
pack-priv static interface	CLContext.CLContextUtil CLContext utility methods interface.

Modifier and Type	Field and Description
private final CLObjectRegistry<CLCommandQueue>	clCommandQueues
private final CLObjectRegistry<CLEvent>	clEvents
private final CLObjectRegistry<CLMem>	clMems
private final CLObjectRegistry<CLProgram>	clPrograms
private final CLObjectRegistry<CLSampler>	clSamplers
private long	contextCallback
private long	printfCallback
private static final CLContext.CLContextUtil	util

Access	Constructor and Description
pack-priv	CLContext(final long pointer, final CLPlatform platform)

Method Summary

Modifier and Type	Method and Description
private boolean	checkCallback(final long callback, final int result)
public static CLContext	Returns: the new CLContext create(final CLPlatform the platform to use platform, final List<CLDevice> the devices to use devices, final IntBuffer the error code result errcode_ret) Creates a new CLContext.
public static CLContext	Returns: the new CLContext create(final CLPlatform the platform to use platform, final List<CLDevice> the devices to use devices, final CLContextCallback the context callback function pfn_notify, final IntBuffer the error code result errcode_ret) Creates a new CLContext.
public static CLContext	Returns: the new CLContext create(final CLPlatform the platform to use platform, final List<CLDevice> the devices to use devices, final CLContextCallback pfn_notify, final Drawable the OpenGL drawable to share objects with share_drawable, final IntBuffer the error code result errcode_ret) Creates a new CLContext.
public static CLContext	Returns: the new CLContext createFromType(final CLPlatform the platform to use platform, final long the device type to use device_type, final IntBuffer the error code result errcode_ret) Creates a new CLContext.
public static CLContext	Returns: the new CLContext createFromType(final CLPlatform the platform to use platform, final long the device type to use device_type, final CLContextCallback the context callback function pfn_notify, final IntBuffer the error code result errcode_ret) Creates a new CLContext.
public static CLContext	Returns: the new CLContext createFromType(final CLPlatform the platform to use platform, final long the device type to use device_type, final CLContextCallback pfn_notify, final Drawable the OpenGL drawable to share objects with share_drawable, final IntBuffer the error code result errcode_ret) Creates a new CLContext.
public CLCommandQueue	Returns: the CLCommandQueue object getCLCommandQueue(final long the command queue object id id) Returns a CLCommandQueue associated with this context.
pack-priv CLObjectRegistry<CLCommandQueue>	getCLCommandQueueRegistry()
public CLEvent	Returns: the CLEvent object getCLEvent(final long the event object id id) Returns a user CLEvent associated with this context.
pack-priv CLObjectRegistry<CLEvent>	getCLEventRegistry()
public CLMem	Returns: the CLMem object getCLMem(final long the memory object id id) Returns a CLMem associated with this context.
pack-priv CLObjectRegistry<CLMem>	getCLMemRegistry()
public CLProgram	Returns: the CLProgram object getCLProgram(final long the program object id id) Returns a CLProgram associated with this context.
pack-priv CLObjectRegistry<CLProgram>	getCLProgramRegistry()
public CLSampler	Returns: the CLSampler object getCLSampler(final long the sampler object id id) Returns a CLSampler associated with this context.
pack-priv CLObjectRegistry<CLSampler>	getCLSamplerRegistry()
public List<CLDevice>	Returns: the list of devices getInfoDevices() Returns the list of devices in context.
public int	Returns: the parameter value getInfoInt(int the parameter param_name) Returns the integer value of the specified parameter.
public List<CLImageFormat>	getSupportedImageFormats(final long flags, final int image_type)
public List<CLImageFormat>	getSupportedImageFormats(final long flags, final int image_type, final Filter<CLImageFormat> filter)
pack-priv void	releaseImpl() Decrements the context's reference count.
pack-priv void	setContextCallback(final long the context callback pointer callback) Associates this context with the specified context callback reference.
pack-priv void	setPrintfCallback(final long the printf callback pointer callback, final int result) Associates this context with the specified printf callback reference.

Inherited from org.lwjgl.opencl.CLObjectChild:: getParent

clCommandQueues	back to summary
private final CLObjectRegistry<CLCommandQueue> clCommandQueues

clEvents	back to summary
private final CLObjectRegistry<CLEvent> clEvents

clMems	back to summary
private final CLObjectRegistry<CLMem> clMems

clPrograms	back to summary
private final CLObjectRegistry<CLProgram> clPrograms

clSamplers	back to summary
private final CLObjectRegistry<CLSampler> clSamplers

contextCallback	back to summary
private long contextCallback

printfCallback	back to summary
private long printfCallback

util	back to summary
private static final CLContext.CLContextUtil util

CLContext	back to summary
pack-priv CLContext(final long pointer, final CLPlatform platform)

Method Detail

checkCallback	back to summary
private boolean checkCallback(final long callback, final int result)

create	back to summary
public static CLContext create(final CLPlatform platform, final List<CLDevice> devices, final IntBuffer errcode_ret) throws LWJGLException Creates a new CLContext. Parameters platform:CLPlatform the platform to use devices:List<CLDevice> the devices to use errcode_ret:IntBuffer the error code result Returns:CLContext the new CLContext Exceptions LWJGLException: if an exception occurs while creating the context

create

back to summary

public static CLContext create(final CLPlatform platform, final List<CLDevice> devices, final IntBuffer errcode_ret) throws LWJGLException

Creates a new CLContext.

Parameters

platform:CLPlatform: the platform to use
devices:List<CLDevice>: the devices to use
errcode_ret:IntBuffer: the error code result

Returns:CLContext

the new CLContext

Exceptions

LWJGLException:: if an exception occurs while creating the context

create	back to summary
public static CLContext create(final CLPlatform platform, final List<CLDevice> devices, final CLContextCallback pfn_notify, final IntBuffer errcode_ret) throws LWJGLException Creates a new CLContext. Parameters platform:CLPlatform the platform to use devices:List<CLDevice> the devices to use pfn_notify:CLContextCallback the context callback function errcode_ret:IntBuffer the error code result Returns:CLContext the new CLContext Exceptions LWJGLException: if an exception occurs while creating the context

create

back to summary

public static CLContext create(final CLPlatform platform, final List<CLDevice> devices, final CLContextCallback pfn_notify, final IntBuffer errcode_ret) throws LWJGLException

Creates a new CLContext.

Parameters

platform:CLPlatform: the platform to use
devices:List<CLDevice>: the devices to use
pfn_notify:CLContextCallback: the context callback function
errcode_ret:IntBuffer: the error code result

Returns:CLContext

the new CLContext

Exceptions

LWJGLException:: if an exception occurs while creating the context

create	back to summary
public static CLContext create(final CLPlatform platform, final List<CLDevice> devices, final CLContextCallback pfn_notify, final Drawable share_drawable, final IntBuffer errcode_ret) throws LWJGLException Creates a new CLContext. Parameters platform:CLPlatform the platform to use devices:List<CLDevice> the devices to use share_drawable:Drawable the OpenGL drawable to share objects with errcode_ret:IntBuffer the error code result Returns:CLContext the new CLContext Exceptions LWJGLException: if an exception occurs while creating the context

create

back to summary

public static CLContext create(final CLPlatform platform, final List<CLDevice> devices, final CLContextCallback pfn_notify, final Drawable share_drawable, final IntBuffer errcode_ret) throws LWJGLException

Creates a new CLContext.

Parameters

platform:CLPlatform: the platform to use
devices:List<CLDevice>: the devices to use
share_drawable:Drawable: the OpenGL drawable to share objects with
errcode_ret:IntBuffer: the error code result

Returns:CLContext

the new CLContext

Exceptions

LWJGLException:: if an exception occurs while creating the context

createFromType	back to summary
public static CLContext createFromType(final CLPlatform platform, final long device_type, final IntBuffer errcode_ret) throws LWJGLException Creates a new CLContext. Parameters platform:CLPlatform the platform to use device_type:long the device type to use errcode_ret:IntBuffer the error code result Returns:CLContext the new CLContext Exceptions LWJGLException: if an exception occurs while creating the context

createFromType

back to summary

public static CLContext createFromType(final CLPlatform platform, final long device_type, final IntBuffer errcode_ret) throws LWJGLException

Creates a new CLContext.

Parameters

platform:CLPlatform: the platform to use
device_type:long: the device type to use
errcode_ret:IntBuffer: the error code result

Returns:CLContext

the new CLContext

Exceptions

LWJGLException:: if an exception occurs while creating the context

createFromType	back to summary
public static CLContext createFromType(final CLPlatform platform, final long device_type, final CLContextCallback pfn_notify, final IntBuffer errcode_ret) throws LWJGLException Creates a new CLContext. Parameters platform:CLPlatform the platform to use device_type:long the device type to use pfn_notify:CLContextCallback the context callback function errcode_ret:IntBuffer the error code result Returns:CLContext the new CLContext Exceptions LWJGLException: if an exception occurs while creating the context

createFromType

back to summary

public static CLContext createFromType(final CLPlatform platform, final long device_type, final CLContextCallback pfn_notify, final IntBuffer errcode_ret) throws LWJGLException

Creates a new CLContext.

Parameters

platform:CLPlatform: the platform to use
device_type:long: the device type to use
pfn_notify:CLContextCallback: the context callback function
errcode_ret:IntBuffer: the error code result

Returns:CLContext

the new CLContext

Exceptions

LWJGLException:: if an exception occurs while creating the context

createFromType	back to summary
public static CLContext createFromType(final CLPlatform platform, final long device_type, final CLContextCallback pfn_notify, final Drawable share_drawable, final IntBuffer errcode_ret) throws LWJGLException Creates a new CLContext. Parameters platform:CLPlatform the platform to use device_type:long the device type to use share_drawable:Drawable the OpenGL drawable to share objects with errcode_ret:IntBuffer the error code result Returns:CLContext the new CLContext Exceptions LWJGLException: if an exception occurs while creating the context

createFromType

back to summary

public static CLContext createFromType(final CLPlatform platform, final long device_type, final CLContextCallback pfn_notify, final Drawable share_drawable, final IntBuffer errcode_ret) throws LWJGLException

Creates a new CLContext.

Parameters

platform:CLPlatform: the platform to use
device_type:long: the device type to use
share_drawable:Drawable: the OpenGL drawable to share objects with
errcode_ret:IntBuffer: the error code result

Returns:CLContext

the new CLContext

Exceptions

LWJGLException:: if an exception occurs while creating the context

getCLCommandQueue	back to summary
public CLCommandQueue getCLCommandQueue(final long id) Returns a CLCommandQueue associated with this context. Parameters id:long the command queue object id Returns:CLCommandQueue the CLCommandQueue object

getCLCommandQueue

back to summary

public CLCommandQueue getCLCommandQueue(final long id)

Returns a CLCommandQueue associated with this context.

Parameters

id:long: the command queue object id

Returns:CLCommandQueue

the CLCommandQueue object

getCLCommandQueueRegistry	back to summary
pack-priv CLObjectRegistry<CLCommandQueue> getCLCommandQueueRegistry()

getCLEvent	back to summary
public CLEvent getCLEvent(final long id) Returns a user CLEvent associated with this context. Parameters id:long the event object id Returns:CLEvent the CLEvent object

getCLEvent

back to summary

public CLEvent getCLEvent(final long id)

Returns a user CLEvent associated with this context.

Parameters

id:long: the event object id

Returns:CLEvent

the CLEvent object

getCLEventRegistry	back to summary
pack-priv CLObjectRegistry<CLEvent> getCLEventRegistry()

getCLMem	back to summary
public CLMem getCLMem(final long id) Returns a CLMem associated with this context. Parameters id:long the memory object id Returns:CLMem the CLMem object

getCLMem

back to summary

public CLMem getCLMem(final long id)

Returns a CLMem associated with this context.

Parameters

id:long: the memory object id

Returns:CLMem

the CLMem object

getCLMemRegistry	back to summary
pack-priv CLObjectRegistry<CLMem> getCLMemRegistry()

getCLProgram	back to summary
public CLProgram getCLProgram(final long id) Returns a CLProgram associated with this context. Parameters id:long the program object id Returns:CLProgram the CLProgram object

getCLProgram

back to summary

public CLProgram getCLProgram(final long id)

Returns a CLProgram associated with this context.

Parameters

id:long: the program object id

Returns:CLProgram

the CLProgram object

getCLProgramRegistry	back to summary
pack-priv CLObjectRegistry<CLProgram> getCLProgramRegistry()

getCLSampler	back to summary
public CLSampler getCLSampler(final long id) Returns a CLSampler associated with this context. Parameters id:long the sampler object id Returns:CLSampler the CLSampler object

getCLSampler

back to summary

public CLSampler getCLSampler(final long id)

Returns a CLSampler associated with this context.

Parameters

id:long: the sampler object id

Returns:CLSampler

the CLSampler object

getCLSamplerRegistry	back to summary
pack-priv CLObjectRegistry<CLSampler> getCLSamplerRegistry()

getInfoDevices	back to summary
public List<CLDevice> getInfoDevices() Returns the list of devices in context. Returns:List<CLDevice> the list of devices

getInfoDevices

back to summary

public List<CLDevice> getInfoDevices()

Returns the list of devices in context.

Returns:List<CLDevice>: the list of devices

getInfoInt	back to summary
public int getInfoInt(int param_name) Returns the integer value of the specified parameter. Parameters param_name:int the parameter Returns:int the parameter value

getInfoInt

back to summary

public int getInfoInt(int param_name)

Returns the integer value of the specified parameter.

Parameters

param_name:int: the parameter

Returns:int

the parameter value

getSupportedImageFormats	back to summary
public List<CLImageFormat> getSupportedImageFormats(final long flags, final int image_type)

getSupportedImageFormats	back to summary
public List<CLImageFormat> getSupportedImageFormats(final long flags, final int image_type, final Filter<CLImageFormat> filter)

releaseImpl	back to summary
pack-priv void releaseImpl() Decrements the context's reference count. If the reference count hits zero, it also deletes any callback objects associated with it.

setContextCallback	back to summary
pack-priv void setContextCallback(final long callback) Associates this context with the specified context callback reference. If the context is invalid, the callback reference is deleted. NO-OP if user_data is 0. Parameters callback:long the context callback pointer

setContextCallback

back to summary

pack-priv void setContextCallback(final long callback)

Associates this context with the specified context callback reference. If the context is invalid, the callback reference is deleted. NO-OP if user_data is 0.

Parameters

callback:long: the context callback pointer

setPrintfCallback	back to summary
pack-priv void setPrintfCallback(final long callback, final int result) Associates this context with the specified printf callback reference. If the context is invalid, the callback reference is deleted. NO-OP if user_data is 0. Parameters callback:long the printf callback pointer

setPrintfCallback

back to summary

pack-priv void setPrintfCallback(final long callback, final int result)

Associates this context with the specified printf callback reference. If the context is invalid, the callback reference is deleted. NO-OP if user_data is 0.

Parameters

callback:long: the printf callback pointer

Modifier and Type	Method and Description
public CLContext	create(CLPlatform platform, List<CLDevice> devices, CLContextCallback pfn_notify, Drawable share_drawable, IntBuffer errcode_ret)
public CLContext	createFromType(CLPlatform platform, long device_type, CLContextCallback pfn_notify, Drawable share_drawable, IntBuffer errcode_ret)
public List<CLDevice>	getInfoDevices(CLContext context)
public List<CLImageFormat>	getSupportedImageFormats(CLContext context, final long flags, final int image_type, Filter<CLImageFormat> filter)

public final Class CLContext

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface CLContext.CLContextUtil

Method Summary

Method Detail