JOCL v2.6.0-rc-20250722
JOCL, OpenCL® API Binding for Java™ (public API).
com.jogamp.opencl.CLSubBuffer< B extends Buffer > Class Template Reference

A sub buffer of a CLBuffer. More...

Inheritance diagram for com.jogamp.opencl.CLSubBuffer< B extends Buffer >:
Collaboration diagram for com.jogamp.opencl.CLSubBuffer< B extends Buffer >:

Public Member Functions

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 of OpenCL 1.1. More...
 
void release ()
 
CLBuffer< B > getParent ()
 Returns the parent buffer this buffer was created from. More...
 
int getOffset ()
 Returns the offset of this sub buffer to its parent in buffer elements. More...
 
int getCLOffset ()
 Returns the offset of this sub buffer to its parent in bytes. More...
 
boolean isSubBuffer ()
 Returns true. More...
 
- Public Member Functions inherited from com.jogamp.opencl.CLBuffer< B >
CLSubBuffer< B > createSubBuffer (int offset, int size, final Mem... flags)
 Creates a sub buffer with the specified region from this buffer. More...
 
void release ()
 
List< CLSubBuffer< B > > getSubBuffers ()
 Returns the list of subbuffers. More...
 
boolean isSubBuffer ()
 Returns true if this is a sub buffer. More...
 

Additional Inherited Members

- Protected Member Functions inherited from com.jogamp.opencl.CLBuffer< B >
 CLBuffer (final CLContext context, final long size, final long id, final int flags)
 
 CLBuffer (final CLContext context, final B directBuffer, final long size, final long id, final int flags)
 

Detailed Description

A sub buffer of a CLBuffer.

Author
Michael Bien

Definition at line 39 of file CLSubBuffer.java.

Member Function Documentation

◆ createSubBuffer()

CLSubBuffer< B > com.jogamp.opencl.CLSubBuffer< B extends Buffer >.createSubBuffer ( final int  origin,
final int  size,
final Mem...  flags 
)

Throws an UnsupportedOperationException since creating sub buffers from sub buffers is not allowed as of OpenCL 1.1.

Definition at line 55 of file CLSubBuffer.java.

◆ getCLOffset()

int com.jogamp.opencl.CLSubBuffer< B extends Buffer >.getCLOffset ( )

Returns the offset of this sub buffer to its parent in bytes.

Definition at line 83 of file CLSubBuffer.java.

Here is the caller graph for this function:

◆ getOffset()

int com.jogamp.opencl.CLSubBuffer< B extends Buffer >.getOffset ( )

Returns the offset of this sub buffer to its parent in buffer elements.

Definition at line 75 of file CLSubBuffer.java.

Here is the caller graph for this function:

◆ getParent()

CLBuffer< B > com.jogamp.opencl.CLSubBuffer< B extends Buffer >.getParent ( )

Returns the parent buffer this buffer was created from.

Definition at line 68 of file CLSubBuffer.java.

Here is the caller graph for this function:

◆ isSubBuffer()

boolean com.jogamp.opencl.CLSubBuffer< B extends Buffer >.isSubBuffer ( )

Returns true.

Definition at line 91 of file CLSubBuffer.java.

Here is the caller graph for this function:

◆ release()

void com.jogamp.opencl.CLSubBuffer< B extends Buffer >.release ( )

Definition at line 60 of file CLSubBuffer.java.

Here is the caller graph for this function:

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