TexelProperties.h

/*
 * #%L
 * OME-QTWIDGETS C++ library for display of Bio-Formats pixel data and metadata.
 * Copyright © 2014 - 2015 Open Microscopy Environment:
 *   - Massachusetts Institute of Technology
 *   - National Institutes of Health
 *   - University of Dundee
 *   - Board of Regents of the University of Wisconsin-Madison
 *   - Glencoe Software, Inc.
 * %%
 * 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 THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT HOLDERS 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 any organization.
 * #L%
 */

#ifndef OME_QTWIDGETS_TEXELPROPERTIES_H
#define OME_QTWIDGETS_TEXELPROPERTIES_H

#include <ome/bioformats/PixelProperties.h>

#include <ome/xml/model/enums/PixelType.h>

#include <QtGui/qopengl.h>

namespace ome
{
  namespace qtwidgets
  {

    template<int>
    struct TexelProperties;

    template<>
    struct TexelProperties< ::ome::xml::model::enums::PixelType::INT8> :
      public ome::bioformats::PixelProperties< ::ome::xml::model::enums::PixelType::INT8>
    {
      static const GLenum internal_format = GL_R8;
      static const GLenum external_format = GL_RED;
      static const ::ome::xml::model::enums::PixelType::enum_value fallback_pixeltype = ome::xml::model::enums::PixelType::INT8;
      static const GLint external_type = GL_BYTE;
      static const bool conversion_required = false;
      static const bool normalization_required = false;
      static const GLint minification_filter = GL_LINEAR_MIPMAP_LINEAR;
      static const GLint magnification_filter = GL_LINEAR;
    };

    template<>
    struct TexelProperties< ::ome::xml::model::enums::PixelType::INT16> :
      public ome::bioformats::PixelProperties< ::ome::xml::model::enums::PixelType::INT16>
    {
      static const GLenum internal_format = GL_R16;
      static const GLenum external_format = GL_RED;
      static const GLint external_type = GL_SHORT;
      static const ::ome::xml::model::enums::PixelType::enum_value fallback_pixeltype = ome::xml::model::enums::PixelType::INT8;
      static const bool conversion_required = false;
      static const bool normalization_required = false;
      static const GLint minification_filter = GL_LINEAR_MIPMAP_LINEAR;
      static const GLint magnification_filter = GL_LINEAR;
    };

    template<>
    struct TexelProperties< ::ome::xml::model::enums::PixelType::INT32> :
      public ome::bioformats::PixelProperties< ::ome::xml::model::enums::PixelType::INT32>
    {
      static const GLenum internal_format = GL_R16;
      static const GLenum external_format = GL_RED;
      static const GLint external_type = GL_INT;
      static const ::ome::xml::model::enums::PixelType::enum_value fallback_pixeltype = ome::xml::model::enums::PixelType::INT16;
      static const bool conversion_required = false;
      static const bool normalization_required = false;
      static const GLint minification_filter = GL_LINEAR_MIPMAP_LINEAR;
      static const GLint magnification_filter = GL_LINEAR;
    };

    template<>
    struct TexelProperties< ::ome::xml::model::enums::PixelType::UINT8> :
      public ome::bioformats::PixelProperties< ::ome::xml::model::enums::PixelType::UINT8>
    {
      static const GLenum internal_format = GL_R8;
      static const GLenum external_format = GL_RED;
      static const GLint external_type = GL_UNSIGNED_BYTE;
      static const ::ome::xml::model::enums::PixelType::enum_value fallback_pixeltype = ome::xml::model::enums::PixelType::UINT8;
      static const bool conversion_required = false;
      static const bool normalization_required = false;
      static const GLint minification_filter = GL_LINEAR_MIPMAP_LINEAR;
      static const GLint magnification_filter = GL_LINEAR;
    };

    template<>
    struct TexelProperties< ::ome::xml::model::enums::PixelType::UINT16> :
      public ome::bioformats::PixelProperties< ::ome::xml::model::enums::PixelType::UINT16>
    {
      static const GLenum internal_format = GL_R16;
      static const GLenum external_format = GL_RED;
      static const GLint external_type = GL_UNSIGNED_SHORT;
      static const ::ome::xml::model::enums::PixelType::enum_value fallback_pixeltype = ome::xml::model::enums::PixelType::UINT8;
      static const bool conversion_required = false;
      static const bool normalization_required = false;
      static const GLint minification_filter = GL_LINEAR_MIPMAP_LINEAR;
      static const GLint magnification_filter = GL_LINEAR;
    };

    template<>
    struct TexelProperties< ::ome::xml::model::enums::PixelType::UINT32> :
      public ome::bioformats::PixelProperties< ::ome::xml::model::enums::PixelType::UINT32>
    {
      static const GLenum internal_format = GL_R16;
      static const GLenum external_format = GL_RED;
      static const GLint external_type = GL_UNSIGNED_INT;
      static const ::ome::xml::model::enums::PixelType::enum_value fallback_pixeltype = ome::xml::model::enums::PixelType::UINT16;
      static const bool conversion_required = false;
      static const bool normalization_required = false;
      static const GLint minification_filter = GL_LINEAR_MIPMAP_LINEAR;
      static const GLint magnification_filter = GL_LINEAR;
    };

    template<>
    struct TexelProperties< ::ome::xml::model::enums::PixelType::FLOAT> :
      public ome::bioformats::PixelProperties< ::ome::xml::model::enums::PixelType::FLOAT>
    {
      static const GLenum internal_format = GL_R32F;
      static const GLenum external_format = GL_RED;
      static const GLint external_type = GL_FLOAT;
      static const ::ome::xml::model::enums::PixelType::enum_value fallback_pixeltype = ome::xml::model::enums::PixelType::INT32;
      static const bool conversion_required = false;
      static const bool normalization_required = true;
      static const GLint minification_filter = GL_LINEAR_MIPMAP_LINEAR;
      static const GLint magnification_filter = GL_LINEAR;
    };

    template<>
    struct TexelProperties< ::ome::xml::model::enums::PixelType::DOUBLE> :
      public ome::bioformats::PixelProperties< ::ome::xml::model::enums::PixelType::DOUBLE>
    {
      static const GLenum internal_format = GL_R32F;
      static const GLenum external_format = GL_RED;
      static const GLint external_type = GL_DOUBLE;
      static const ::ome::xml::model::enums::PixelType::enum_value fallback_pixeltype = ome::xml::model::enums::PixelType::FLOAT;
      static const bool conversion_required = false;
      static const bool normalization_required = true;
      static const GLint minification_filter = GL_LINEAR_MIPMAP_LINEAR;
      static const GLint magnification_filter = GL_LINEAR;
    };

    template<>
    struct TexelProperties< ::ome::xml::model::enums::PixelType::BIT> :
      public ome::bioformats::PixelProperties< ::ome::xml::model::enums::PixelType::BIT>
    {
      static const GLenum internal_format = GL_R8;
      static const GLenum external_format = GL_RED;
      static const GLint external_type = GL_UNSIGNED_BYTE;
      static const ::ome::xml::model::enums::PixelType::enum_value fallback_pixeltype = ome::xml::model::enums::PixelType::BIT;
      static const bool conversion_required = true;
      static const bool normalization_required = false;
      static const GLint minification_filter = GL_NEAREST_MIPMAP_LINEAR;
      static const GLint magnification_filter = GL_NEAREST;
    };

    template<>
    struct TexelProperties< ::ome::xml::model::enums::PixelType::COMPLEX> :
      public ome::bioformats::PixelProperties< ::ome::xml::model::enums::PixelType::COMPLEX>
    {
      static const GLenum internal_format = GL_RG32F;
      static const GLenum external_format = GL_RG;
      static const GLint external_type = GL_FLOAT;
      static const ::ome::xml::model::enums::PixelType::enum_value fallback_pixeltype = ome::xml::model::enums::PixelType::COMPLEX;
      static const bool conversion_required = false;
      static const bool normalization_required = true;
      static const GLint minification_filter = GL_LINEAR_MIPMAP_LINEAR;
      static const GLint magnification_filter = GL_LINEAR;
    };

    template<>
    struct TexelProperties< ::ome::xml::model::enums::PixelType::DOUBLECOMPLEX> :
      public ome::bioformats::PixelProperties< ::ome::xml::model::enums::PixelType::DOUBLECOMPLEX>
    {
      static const GLenum internal_format = GL_RG32F;
      static const GLenum external_format = GL_RG;
      static const GLint external_type = GL_DOUBLE;
      static const ::ome::xml::model::enums::PixelType::enum_value fallback_pixeltype = ome::xml::model::enums::PixelType::COMPLEX;
      static const bool conversion_required = false;
      static const bool normalization_required = true;
      static const GLint minification_filter = GL_LINEAR_MIPMAP_LINEAR;
      static const GLint magnification_filter = GL_LINEAR;
    };

    GLenum
    textureInternalFormat(::ome::xml::model::enums::PixelType pixeltype);

    GLenum
    textureInternalFormatFallback(GLenum format);

    GLenum
    textureExternalFormat(::ome::xml::model::enums::PixelType pixeltype);

    GLint
    textureExternalType(::ome::xml::model::enums::PixelType pixeltype);

    ::ome::xml::model::enums::PixelType
    texturePixelTypeFallback(::ome::xml::model::enums::PixelType pixeltype);

    bool
    textureConversionRequired(::ome::xml::model::enums::PixelType pixeltype);

    bool
    textureNormalizationRequired(::ome::xml::model::enums::PixelType pixeltype);

    GLint
    textureMinificationFilter(::ome::xml::model::enums::PixelType pixeltype);

    GLint
    textureMagnificationFilter(::ome::xml::model::enums::PixelType pixeltype);

  }
}

#endif // OME_QTWIDGETS_TEXELPROPERTIES_H

/*
 * Local Variables:
 * mode:C++
 * End:
 */