JOCL v2.6.0-rc-20250722
JOCL, OpenCL® API Binding for Java™ (public API).
com.jogamp.opencl.util.CLMultiContext Class Reference

Utility for organizing multiple CLContexts. More...

Inheritance diagram for com.jogamp.opencl.util.CLMultiContext:
Collaboration diagram for com.jogamp.opencl.util.CLMultiContext:

Public Member Functions

void release ()
 Releases all contexts. More...
 
List< CLContextgetContexts ()
 
List< CLDevicegetDevices ()
 Returns a list containing all devices used in this multi context. More...
 
boolean isReleased ()
 Returns true if release() has been called. More...
 
String toString ()
 
void release ()
 Releases the OpenCL resource. More...
 
boolean isReleased ()
 Returns true if release() has been called. More...
 

Static Public Member Functions

static CLMultiContext create (final CLPlatform... platforms)
 Creates a multi context with all devices of the specified platforms. More...
 
static CLMultiContext create (final CLPlatform[] platforms, final CLDevice.Type... types)
 Creates a multi context with all devices of the specified platforms and types. More...
 
static CLMultiContext create (final CLPlatform[] platforms, final Filter< CLDevice >... filters)
 Creates a multi context with all matching devices of the specified platforms. More...
 
static CLMultiContext create (final Collection< CLDevice > devices)
 Creates a multi context with the specified devices. More...
 
static CLMultiContext wrap (final CLContext... contexts)
 Creates a multi context with specified contexts. More...
 

Detailed Description

Utility for organizing multiple CLContexts.

Author
Michael Bien

Definition at line 25 of file CLMultiContext.java.

Member Function Documentation

◆ create() [1/4]

static CLMultiContext com.jogamp.opencl.util.CLMultiContext.create ( final CLPlatform...  platforms)
static

Creates a multi context with all devices of the specified platforms.

Definition at line 37 of file CLMultiContext.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ create() [2/4]

static CLMultiContext com.jogamp.opencl.util.CLMultiContext.create ( final CLPlatform[]  platforms,
final CLDevice.Type...  types 
)
static

Creates a multi context with all devices of the specified platforms and types.

Definition at line 45 of file CLMultiContext.java.

Here is the call graph for this function:

◆ create() [3/4]

static CLMultiContext com.jogamp.opencl.util.CLMultiContext.create ( final CLPlatform[]  platforms,
final Filter< CLDevice >...  filters 
)
static

Creates a multi context with all matching devices of the specified platforms.

Definition at line 53 of file CLMultiContext.java.

Here is the call graph for this function:

◆ create() [4/4]

static CLMultiContext com.jogamp.opencl.util.CLMultiContext.create ( final Collection< CLDevice devices)
static

Creates a multi context with the specified devices.

The devices don't have to be from the same platform.

Definition at line 72 of file CLMultiContext.java.

Here is the call graph for this function:

◆ getContexts()

List< CLContext > com.jogamp.opencl.util.CLMultiContext.getContexts ( )

Definition at line 150 of file CLMultiContext.java.

Here is the caller graph for this function:

◆ getDevices()

List< CLDevice > com.jogamp.opencl.util.CLMultiContext.getDevices ( )

Returns a list containing all devices used in this multi context.

Definition at line 157 of file CLMultiContext.java.

Here is the caller graph for this function:

◆ isReleased()

boolean com.jogamp.opencl.util.CLMultiContext.isReleased ( )

Returns true if release() has been called.

Implements com.jogamp.opencl.CLResource.

Definition at line 165 of file CLMultiContext.java.

◆ release()

void com.jogamp.opencl.util.CLMultiContext.release ( )

Releases all contexts.

See also
CLContext::release()

Implements com.jogamp.opencl.CLResource.

Definition at line 139 of file CLMultiContext.java.

Here is the caller graph for this function:

◆ toString()

String com.jogamp.opencl.util.CLMultiContext.toString ( )

Definition at line 170 of file CLMultiContext.java.

Here is the call graph for this function:

◆ wrap()

static CLMultiContext com.jogamp.opencl.util.CLMultiContext.wrap ( final CLContext...  contexts)
static

Creates a multi context with specified contexts.

Definition at line 97 of file CLMultiContext.java.


The documentation for this class was generated from the following file: