JOCL v2.6.0-rc-20250722
JOCL, OpenCL® API Binding for Java™ (public API).
CLImage2d.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.CLException.*;
37
38/**
39 *
40 * @author Michael Bien
41 */
42public class CLImage2d<B extends Buffer> extends CLImage<B> {
43
44 private CLImage2d(final CLContext context, final B directBuffer, final CLImageFormat format, final int width, final int height, final long id, final int flags) {
45 super(context, directBuffer, format, width, height, id, flags);
46 }
47
48 protected CLImage2d(final CLContext context, final B directBuffer, final CLImageFormat format, final CLImageInfoAccessor accessor, final int width, final int height, final long id, final int flags) {
49 super(context, directBuffer, format, accessor, width, height, id, flags);
50 }
51
52 static <B extends Buffer> CLImage2d<B> createImage(final CLContext context, final B directBuffer,
53 final int width, final int height, final int rowPitch, final CLImageFormat format, final int flags) {
54
55 final CL cl = context.getPlatform().getCLBinding();
56 final IntBuffer err = Buffers.newDirectIntBuffer(1);
57 B host_ptr = null;
58 if(isHostPointerFlag(flags)) {
59 host_ptr = directBuffer;
60 }
61 final long id = cl.clCreateImage2D(context.ID, flags, format.getFormatImpl(), width, height, rowPitch, host_ptr, err);
62 checkForError(err.get(), "can not create 2d image");
63
64 return new CLImage2d<B>(context, directBuffer, format, width, height, id, flags);
65 }
66
67 @Override
68 public <T extends Buffer> CLImage2d<T> cloneWith(final T directBuffer) {
69 return new CLImage2d<T>(context, directBuffer, format, width, height, ID, FLAGS);
70 }
71
72
73 @Override
74 public String toString() {
75 return "CLImage2d [id: " + ID+" width: "+width+" height: "+height+"]";
76 }
77
78}
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
CLImage2d(final CLContext context, final B directBuffer, final CLImageFormat format, final CLImageInfoAccessor accessor, final int width, final int height, final long id, final int flags)
Definition: CLImage2d.java:48
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
Java bindings to OpenCL, the Open Computing Language.
Definition: CL.java:26
long clCreateImage2D(long context, long flags, CLImageFormatImpl image_format, long image_width, long image_height, long image_row_pitch, Buffer host_ptr, IntBuffer errcode_ret)
Interface to C language function: cl_mem {@native clCreateImage2D}(cl_context context,...