JOCL v2.6.0-rc-20250722
JOCL, OpenCL® API Binding for Java™ (public API).
CLImage3d.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.llb.CL;
33import java.nio.Buffer;
34import java.nio.IntBuffer;
35
36import static com.jogamp.opencl.llb.CL.*;
37import static com.jogamp.opencl.CLException.*;
38
39/**
40 *
41 * @author Michael Bien
42 */
43public class CLImage3d<B extends Buffer> extends CLImage<B> {
44
45 public final int depth;
46
47 private CLImage3d(final CLContext context, final B directBuffer, final CLImageFormat format, final int width, final int height, final int depth, final long id, final int flags) {
48 super(context, directBuffer, format, width, height, id, flags);
49 this.depth = depth;
50 }
51
52 protected CLImage3d(final CLContext context, final B directBuffer, final CLImageFormat format, final CLImageInfoAccessor accessor, final int width, final int height, final int depth, final long id, final int flags) {
53 super(context, directBuffer, format, accessor, width, height, id, flags);
54 this.depth = depth;
55 }
56
57
58 static <B extends Buffer> CLImage3d<B> createImage(final CLContext context, final B directBuffer,
59 final int width, final int height, final int depth, final int rowPitch, final int slicePitch, final CLImageFormat format, final int flags) {
60
61 final CL cl = context.getPlatform().getCLBinding();
62 final IntBuffer err = Buffers.newDirectIntBuffer(1);
63 B host_ptr = null;
64 if(isHostPointerFlag(flags)) {
65 host_ptr = directBuffer;
66 }
67 final long id = cl.clCreateImage3D(context.ID, flags, format.getFormatImpl(), width, height, depth, rowPitch, slicePitch, host_ptr, err);
68 checkForError(err.get(), "can not create 2d image");
69
70 return new CLImage3d<B>(context, directBuffer, format, width, height, depth, id, flags);
71 }
72
73 @Override
74 public <T extends Buffer> CLImage3d<T> cloneWith(final T directBuffer) {
75 return new CLImage3d<T>(context, directBuffer, format, width, height, depth, ID, FLAGS);
76 }
77
78 /**
79 * Returns the size in bytes of a 2D slice of this 3D image.
80 */
81 public int getSlicePitch() {
82 return (int)imageInfo.getLong(CL_IMAGE_SLICE_PITCH);
83 }
84
85 /**
86 * Returns the depth of this image in pixels.
87 */
88 public int getDepth() {
89 return depth;
90 }
91
92 @Override
93 public String toString() {
94 return "CLImage3d [id: " + ID+" width: "+width+" height: "+height+" depth: "+depth+"]";
95 }
96}
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
int getSlicePitch()
Returns the size in bytes of a 2D slice of this 3D image.
Definition: CLImage3d.java:81
int getDepth()
Returns the depth of this image in pixels.
Definition: CLImage3d.java:88
CLImage3d(final CLContext context, final B directBuffer, final CLImageFormat format, final CLImageInfoAccessor accessor, final int width, final int height, final int depth, final long id, final int flags)
Definition: CLImage3d.java:52
Represents the OpenCL image format with its channeltype and order.
CLImageFormatImpl getFormatImpl()
Returns the struct accessor for the cl_image_format struct.
final long ID
The OpenCL object handle.
Definition: CLObject.java:41
final long getLong(final int key)
Returns the long value for the given key.
Java bindings to OpenCL, the Open Computing Language.
Definition: CL.java:26
long clCreateImage3D(long context, long flags, CLImageFormatImpl image_format, long image_width, long image_height, long image_depth, long image_row_pitch, long image_slice_pitch, Buffer host_ptr, IntBuffer errcode_ret)
Interface to C language function: cl_mem {@native clCreateImage3D}(cl_context context,...