JOCL v2.6.0-rc-20250722
JOCL, OpenCL® API Binding for Java™ (public API).
CLSubBuffer.java
Go to the documentation of this file.
1/*
2 * Copyright 2009 - 2010 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
31import com.jogamp.common.nio.Buffers;
32import com.jogamp.opencl.CLMemory.Mem;
33import java.nio.Buffer;
34
35/**
36 * A sub buffer of a CLBuffer.
37 * @author Michael Bien
38 */
39public class CLSubBuffer<B extends Buffer> extends CLBuffer<B> {
40
41 private final CLBuffer<B> parent;
42 private final int offset;
43
44 CLSubBuffer(final CLBuffer<B> parent, final int origin, final int size, final B directBuffer, final long id, final int flags) {
45 super(parent.getContext(), directBuffer, size, id, flags);
46 this.parent = parent;
47 this.offset = origin;
48 }
49
50 /**
51 * Throws an UnsupportedOperationException since creating sub buffers
52 * from sub buffers is not allowed as of OpenCL 1.1.
53 */
54 @Override
55 public CLSubBuffer<B> createSubBuffer(final int origin, final int size, final Mem... flags) {
56 throw new UnsupportedOperationException("creating sub buffers from sub buffers is not allowed.");
57 }
58
59 @Override
60 public void release() {
61 parent.onReleaseSubBuffer(this);
62 super.release();
63 }
64
65 /**
66 * Returns the parent buffer this buffer was created from.
67 */
69 return parent;
70 }
71
72 /**
73 * Returns the offset of this sub buffer to its parent in buffer elements.
74 */
75 public int getOffset() {
76 final int elemSize = buffer==null ? 1 : Buffers.sizeOfBufferElem(buffer);
77 return offset/elemSize;
78 }
79
80 /**
81 * Returns the offset of this sub buffer to its parent in bytes.
82 */
83 public int getCLOffset() {
84 return offset;
85 }
86
87 /**
88 * Returns true.
89 */
90 @Override
91 public boolean isSubBuffer() {
92 return true;
93 }
94}
OpenCL buffer object wrapping an optional NIO buffer.
Definition: CLBuffer.java:46
A sub buffer of a CLBuffer.
CLSubBuffer< B > createSubBuffer(final int origin, final int size, final Mem... flags)
Throws an UnsupportedOperationException since creating sub buffers from sub buffers is not allowed as...
int getOffset()
Returns the offset of this sub buffer to its parent in buffer elements.
CLBuffer< B > getParent()
Returns the parent buffer this buffer was created from.
boolean isSubBuffer()
Returns true.
int getCLOffset()
Returns the offset of this sub buffer to its parent in bytes.
Memory settings for configuring CLMemory.
Definition: CLMemory.java:289