com.jogamp.opencl.CLImageFormat Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jocl-android Show documentation
Show all versions of jocl-android Show documentation
Java™ Binding for the OpenCL® API (Android runtime)
The newest version!
/*
* Copyright 2009 - 2010 JogAmp Community. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of JogAmp Community.
*/
package com.jogamp.opencl;
import com.jogamp.opencl.llb.impl.CLImageFormatImpl;
import static com.jogamp.opencl.llb.CL.*;
/**
* Represents the OpenCL image format with its channeltype and order.
* @author Michael Bien
* @see CLContext#getSupportedImage2dFormats(com.jogamp.opencl.CLMemory.Mem[])
* @see CLContext#getSupportedImage3dFormats(com.jogamp.opencl.CLMemory.Mem[])
*/
public final class CLImageFormat {
private final CLImageFormatImpl format;
CLImageFormat() {
format = CLImageFormatImpl.create();
}
CLImageFormat(final CLImageFormatImpl format) {
this.format = format;
}
public CLImageFormat(final ChannelOrder order, final ChannelType type) {
format = CLImageFormatImpl.create();
setImageChannelOrder(order);
setImageChannelDataType(type);
}
public CLImageFormat setImageChannelOrder(final ChannelOrder order) {
format.setImageChannelOrder(order.ORDER);
return this;
}
public CLImageFormat setImageChannelDataType(final ChannelType type) {
format.setImageChannelDataType(type.TYPE);
return this;
}
public ChannelOrder getImageChannelOrder() {
return ChannelOrder.valueOf(format.getImageChannelOrder());
}
public ChannelType getImageChannelDataType() {
return ChannelType.valueOf(format.getImageChannelDataType());
}
/**
* Returns the struct accessor for the cl_image_format struct.
*/
public CLImageFormatImpl getFormatImpl() {
return format;
}
@Override
public String toString() {
return "CLImageFormat["+getImageChannelOrder()+" "+getImageChannelDataType()+"]";
}
@Override
public boolean equals(final Object obj) {
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
final CLImageFormat other = (CLImageFormat) obj;
if (this.getImageChannelDataType() != other.getImageChannelDataType()) {
return false;
}
if (this.getImageChannelOrder() != other.getImageChannelOrder()) {
return false;
}
return true;
}
@Override
public int hashCode() {
int hash = 5;
hash = 47 * hash + (this.getImageChannelDataType() != null ? this.getImageChannelDataType().hashCode() : 0);
hash = 47 * hash + (this.getImageChannelOrder() != null ? this.getImageChannelOrder().hashCode() : 0);
return hash;
}
/**
* Specifies the number of channels and the channel layout i.e. the memory
* layout in which channels are stored in the image.
*/
public enum ChannelOrder {
/**
*
*/
R(CL_R),
/**
*
*/
Rx(CL_Rx),
/**
*
*/
A(CL_A),
/**
*
*/
RG(CL_RG),
/**
*
*/
RGx(CL_RGx),
/**
*
*/
RA(CL_RA),
/**
* This format can only be used if channel data type is one of the following values:
* {@link ChannelType#UNORM_SHORT_565}, {@link ChannelType#UNORM_SHORT_555}
* or {@link ChannelType#UNORM_INT_101010}.
*/
RGB(CL_RGB),
/**
*
*/
RGBx(CL_RGBx),
/**
*
*/
RGBA(CL_RGBA),
/**
* This format can only be used if channel data type is one of the following values:
* {@link ChannelType#UNORM_INT8}, {@link ChannelType#SNORM_INT8}, {@link ChannelType#SIGNED_INT8}
* or {@link ChannelType#UNSIGNED_INT8}.
*/
ARGB(CL_ARGB),
/**
* @see #ARGB
*/
BGRA(CL_BGRA),
/**
* This format can only be used if channel data type is one of the following values:
* {@link ChannelType#UNORM_INT8}, {@link ChannelType#UNORM_INT16}, {@link ChannelType#SNORM_INT8},
* {@link ChannelType#SNORM_INT16}, {@link ChannelType#HALF_FLOAT}, or {@link ChannelType#FLOAT}.
*/
INTENSITY(CL_INTENSITY),
/**
* This format can only be used if channel data type is one of the following values:
* {@link ChannelType#UNORM_INT8}, {@link ChannelType#UNORM_INT16}, {@link ChannelType#SNORM_INT8},
* {@link ChannelType#SNORM_INT16}, {@link ChannelType#HALF_FLOAT}, or {@link ChannelType#FLOAT}.
*/
LUMINANCE(CL_LUMINANCE);
/**
* Value of wrapped OpenCL flag.
*/
public final int ORDER;
private ChannelOrder(final int order) {
this.ORDER = order;
}
public static ChannelOrder valueOf(final int orderFlag) {
switch (orderFlag) {
case CL_R:
return R;
case CL_Rx:
return Rx;
case CL_A:
return A;
case CL_INTENSITY:
return INTENSITY;
case CL_LUMINANCE:
return LUMINANCE;
case CL_RG:
return RG;
case CL_RGx:
return RGx;
case CL_RA:
return RA;
case CL_RGB:
return RGB;
case CL_RGBx:
return RGBx;
case CL_RGBA:
return RGBA;
case CL_ARGB:
return ARGB;
case CL_BGRA:
return BGRA;
}
return null;
}
}
/**
* Describes the size of the channel data type.
*/
public enum ChannelType {
/**
* Each channel component is a normalized signed 8-bit integer value.
*/
SNORM_INT8(CL_SNORM_INT8),
/**
* Each channel component is a normalized signed 16-bit integer value.
*/
SNORM_INT16(CL_SNORM_INT16),
/**
* Each channel component is a normalized unsigned 8-bit integer value.
*/
UNORM_INT8(CL_UNORM_INT8),
/**
* Each channel component is a normalized unsigned 16-bit integer value.
*/
UNORM_INT16(CL_UNORM_INT16),
/**
* Represents a normalized 5-6-5 3-channel RGB image. The channel order must
* be {@link ChannelOrder#RGB}.
*/
UNORM_SHORT_565(CL_UNORM_SHORT_565),
/**
* Represents a normalized x-5-5-5 4-channel xRGB image. The channel order must
* be {@link ChannelOrder#RGB}.
*/
UNORM_SHORT_555(CL_UNORM_SHORT_555),
/**
* Represents a normalized x-10-10-10 4-channel xRGB image. The channel order
* must be {@link ChannelOrder#RGB}.
*/
UNORM_INT_101010(CL_UNORM_INT_101010),
/**
* Each channel component is an unnormalized signed 8-bit integer value.
*/
SIGNED_INT8(CL_SIGNED_INT8),
/**
* Each channel component is an unnormalized signed 16-bit integer value.
*/
SIGNED_INT16(CL_SIGNED_INT16),
/**
* Each channel component is an unnormalized signed 32-bit integer value.
*/
SIGNED_INT32(CL_SIGNED_INT32),
/**
* Each channel component is an unnormalized unsigned 8-bit integer value.
*/
UNSIGNED_INT8(CL_UNSIGNED_INT8),
/**
* Each channel component is an unnormalized unsigned 16-bit integer value.
*/
UNSIGNED_INT16(CL_UNSIGNED_INT16),
/**
* Each channel component is an unnormalized unsigned 32-bit integer value.
*/
UNSIGNED_INT32(CL_UNSIGNED_INT32),
/**
* Each channel component is a 16-bit half-float value.
*/
HALF_FLOAT(CL_HALF_FLOAT),
/**
* Each channel component is a single precision floating-point value.
*/
FLOAT(CL_FLOAT);
/**
* Value of wrapped OpenCL flag.
*/
public final int TYPE;
private ChannelType(final int channel) {
this.TYPE = channel;
}
public static ChannelType valueOf(final int channelFlag) {
switch (channelFlag) {
case CL_SNORM_INT8:
return SNORM_INT8;
case CL_SNORM_INT16:
return SNORM_INT16;
case CL_UNORM_INT8:
return UNORM_INT8;
case CL_UNORM_INT16:
return UNORM_INT16;
case CL_UNORM_SHORT_565:
return UNORM_SHORT_565;
case CL_UNORM_SHORT_555:
return UNORM_SHORT_555;
case CL_UNORM_INT_101010:
return UNORM_INT_101010;
case CL_SIGNED_INT8:
return SIGNED_INT8;
case CL_SIGNED_INT16:
return SIGNED_INT16;
case CL_SIGNED_INT32:
return SIGNED_INT32;
case CL_UNSIGNED_INT8:
return UNSIGNED_INT8;
case CL_UNSIGNED_INT16:
return UNSIGNED_INT16;
case CL_UNSIGNED_INT32:
return UNSIGNED_INT32;
case CL_HALF_FLOAT:
return HALF_FLOAT;
case CL_FLOAT:
return FLOAT;
}
return null;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy