JOCL v2.6.0-rc-20250722
JOCL, OpenCL® API Binding for Java™ (public API).
CLObject.java
Go to the documentation of this file.
1/*
2 * Copyright (c) 2009 JogAmp Community. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without modification, are
5 * permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice, this list of
8 * conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
11 * of conditions and the following disclaimer in the documentation and/or other materials
12 * provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
16 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 *
24 * The views and conclusions contained in the software and documentation are those of the
25 * authors and should not be interpreted as representing official policies, either expressed
26 * or implied, of JogAmp Community.
27 */
28
29package com.jogamp.opencl;
30
31
32/**
33 * Common superclass for all OpenCL objects.
34 * @author Michael Bien
35 */
36public abstract class CLObject {
37
38 /**
39 * The OpenCL object handle.
40 */
41 public final long ID;
42
43 protected CLContext context;
44
45 CLObject(final long ID) {
46 this.context = null;
47 this.ID = ID;
48 }
49
50 CLObject(final CLContext context, final long ID) {
51 this.context = context;
52 this.ID = ID;
53 }
54
55 /**
56 * Returns the context for this OpenCL object.
57 */
59 return context;
60 }
61
62 /**
63 * Returns the platform for this OpenCL object.
64 */
66 return context.getPlatform();
67 }
68
69 /**
70 * Returns the OpenCL object handle
71 */
72 public long getID() {
73 return ID;
74 }
75
76 @Override
77 public String toString() {
78 return getClass().getSimpleName() + " [id: " + ID
79 + " context: " + context+"]";
80 }
81
82}
CLContext is responsible for managing objects such as command-queues, memory, program and kernel obje...
Definition: CLContext.java:79
CLPlatform getPlatform()
Returns the CLPlatform this context is running on.
Definition: CLContext.java:569
Common superclass for all OpenCL objects.
Definition: CLObject.java:36
long getID()
Returns the OpenCL object handle.
Definition: CLObject.java:72
CLContext getContext()
Returns the context for this OpenCL object.
Definition: CLObject.java:58
final long ID
The OpenCL object handle.
Definition: CLObject.java:41
CLPlatform getPlatform()
Returns the platform for this OpenCL object.
Definition: CLObject.java:65
CLPlatfrorm representing a OpenCL implementation (e.g.
Definition: CLPlatform.java:99