gl2d_texture_interface.h

Go to the documentation of this file.

#ifndef SDK_GL2D_TEXTURE_INTERFACE_H_
#define SDK_GL2D_TEXTURE_INTERFACE_H_
#pragma once
 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/sdk_component_base.h>
#include <base/inc/geometry/geometry_base_types.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <visualizationlayer/inc/gl2d/gl2d_canvas_func/gl2d_canvas_utils_interface.h>
 
SDK_GL2D_BEGIN_NAMESPACE
 
FWD_DECL_INTERFACE(IGL2DCanvas);
FWD_DECL_INTERFACE(IGL2DTexture);
 
enum GL2DTexturePropertyIDs
{
  kGL2DTexturePropertyID_AntiAliasing = 0,
 
  kGL2DTexturePropertyID_CanClip      = 1,
};
 
enum GL2DTextureFormat
{
  // Given textures can be created via IGL2DCanvas::CreateTexture method
  // GetBits/Clone/CopyTo/SaveTexture operations can be unavailable for some formats
  kGL2DTextureFormat_RGBA       = 0, // R8G8B8A8, 0xAABBGGRR
  kGL2DTextureFormat_BGRA       = 1, // B8G8R8A8, 0xAARRGGBB <- Not recommended for iMX6
  kGL2DTextureFormat_RGB        = 2, // R8G8B8,   0xBBGGRR
  kGL2DTextureFormat_RGB16      = 3, // B5G6R5,   0xR5G6B5
 
  // Given texture can be created via IGL2DCanvas::CreateClippingTexture method
  // (Device should support R8/A8 textures)
  // Clone operation is not supported
  // GetBits/CopyTo/SaveTexture operation can be unavailable
  kGL2DTextureFormat_Grayscale  = 4, // X8,       0xX8 <- Create/Clone are not allowed
                                     //                   GetBits/CopyTo can be unavailable
 
  // Given texture can be created via IGL2DCanvas::CreateIndexedTexture method
  // GetBits/Clone/CopyTo operations can be unavailable
  // SaveTexture operation is not supported
  kGL2DTextureFormat_Indexed_I8 = 5, // I8,       0xI8 <- GetBits/Clone/CopyTo can be unavailable
                                     // Each I8 index points to appropriate
                                     // color from 256 colors palette
 
  // Given set of textures can't be created externally, they are for
  // internal usage only. 
  // GetBits/Clone/CopyTo/SaveTexture operations are not supported
  kGL2DTextureFormat_Data_Float = 1000, // Internal data (float) texture
  kGL2DTextureFormat_Depth      = 1001, // Internal depth texture
};
 
enum GL2DNativeTextureFormat
{
  kGL2DNativeTextureFormat_RGBA       = 0, // R8G8B8A8,    0xAABBGGRR
  kGL2DNativeTextureFormat_BGRA       = 1, // B8G8R8A8,    0xAARRGGBB
  kGL2DNativeTextureFormat_RGB        = 2, // R8G8B8,      0xBBGGRR
  kGL2DNativeTextureFormat_RGB16      = 3, // B5G6R5,      0xR5G6B5
  kGL2DNativeTextureFormat_R8         = 4, // R8,          0xR8
  kGL2DNativeTextureFormat_A8         = 5, // A8,          0xA8
 
  // Given set of textures can't be created externally, they are for
  // internal usage only
  kGL2DNativeTextureFormat_Data_Float = 1000, // Internal data (float) texture format
  kGL2DNativeTextureFormat_Depth_Int  = 1001, // Internal depth (integer) texture format
};
 
class IGL2DTexture : public ISDKProperties
{
public:
  virtual void SDK_CALLTYPE Dump() const throw() = 0;
 
  virtual IGL2DCanvasSP SDK_CALLTYPE GetParent() const throw() = 0;
 
  virtual SDKSize SDK_CALLTYPE GetSize() const throw() = 0;
  virtual GL2DTextureFormat SDK_CALLTYPE GetFormat() const throw() = 0;
  virtual GL2DNativeTextureFormat SDK_CALLTYPE GetNativeFormat() const throw() = 0;
  virtual bool SDK_CALLTYPE IsPremultipliedColors() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetMemSize() const throw() = 0;
 
  virtual SDKInt32 SDK_CALLTYPE GetID() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetBits(
    void* const data) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Clone(IGL2DTextureSP& cloned_tex) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE CopyTo(const SDKRect2D& src_tex_rect, 
    const SDKPointI2D& dst_pos, const IGL2DTextureSP& dst_tex) throw() = 0;
  inline SDKResult SDK_CALLTYPE CopyTo(
    const SDKPointI2D& dst_pos, const IGL2DTextureSP& dst_tex)
  {
    const SDKSize src_tex_size = GetSize();
    const SDKRect2D src_tex_rect = 
    { 0L, 0L, src_tex_size.width, src_tex_size.height };
 
    return CopyTo(src_tex_rect, dst_pos, dst_tex);
  }
 
  virtual SDKResult SDK_CALLTYPE SaveTexture(
    const SDKAny& file_path, const GL2DImageFormat& format) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IGL2DTexture)
  SDK_END_INTERFACE(IGL2DTexture)
};
SDK_DECLARE_IID(IGL2DTexture)
 
SDK_GL2D_END_NAMESPACE
 
#endif // SDK_GL2D_TEXTURE_INTERFACE_H_