gl2d_caps_interface.h

Go to the documentation of this file.

#ifndef SDK_GL2D_CAPS_INTERFACE_H_
#define SDK_GL2D_CAPS_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/interfaces/properties/properties_interface.h>
#include <visualizationlayer/inc/vis_const.h>
 
SDK_GL2D_BEGIN_NAMESPACE
 
FWD_DECL_INTERFACE(IGL2DCanvas);
FWD_DECL_INTERFACE(IGL2DCaps);
 
enum GL2DCapsPropertyIDs
{
};
 
enum GL2DGpuType
{
  kGL2DGpuType_Unknown    = 0, // Unknown GPU type
  kGL2DGpuType_Integrated = 1, // Integrated GPU (Intel HD/etc)
  kGL2DGpuType_Discrete   = 2, // Discrete GPU (nVidia/etc)
};
 
enum GL2DGpuVendor
{
  kGL2DGpuVendor_Unknown  = 0,   // Unknown GPU vendor
  kGL2DGpuVendor_Intel    = 1,   // Intel (Vendor: "Intel")
  kGL2DGpuVendor_nVidia   = 2,   // nVidia (Vendor: "NVIDIA Corporation")
  kGL2DGpuVendor_ATI_AMD  = 3,   // ATI/AMD (Vendor: "ATI Technologies Inc.")
  kGL2DGpuVendor_Vivante  = 4,   // Vivante (Vendor: "Vivante Corporation")
  kGL2DGpuVendor_ARM      = 5,   // ARM (Vendor: "ARM")
  kGL2DGpuVendor_Qualcomm = 6,   // Qualcomm (Vendor: "Qualcomm")
 
  kGL2DGpuVendor_VMWare   = 50,  // Software runs on VMWare VM (Vendor: "VMware, Inc.")
  kGL2DGpuVendor_Other    = 100, // Other GPU vendor, not listed here
};
 
enum GL2DCanvasOperationType
{
  // Clipping operation
  // Supported by all of known devices so far            
  kGL2DCanvasOperationType_Clipping                       = 0,
                                                          
  // Draw mesh (colored mesh) operation                   
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawMesh                       = 1,
 
  // Draw mesh (colored mesh) with perspective projection operation
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawMeshWithPerspectiveProj    = 2,
 
  // Draw lighted 3D mesh operation                   
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawLightedMesh3D              = 3,
 
  // Draw texture operation                               
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawTexture                    = 4,
 
  // Draw textures operation                              
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawTextures                   = 5,
                                                          
  // Draw sprites operation                               
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawSprites                    = 6, 
 
  // Draw sprites with perspective projection operation
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawSpritesWithPerspProj       = 7,
 
  // Draw simple lines operation                          
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawSimpleLine                 = 8, 
                                                          
  // Draw fast solid lines/multilines operation           
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawFastSolidLine              = 9, 
 
  // Draw fast solid lines/multilines with perspective projection operation          
  // Supported by all of known devices so far            
  kGL2DCanvasOperationType_DrawFastSolidLineWithPerspProj = 10,
 
  // Draw fast dash lines/multilines operation           
  // Supported by all of known devices so far            
  kGL2DCanvasOperationType_DrawFastDashLine               = 11, 
                                                          
  // Draw Rougier solid lines operation                   
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawRougierSolidLine           = 12, 
                                                          
  // Draw Rougier dash lines operation                    
  // Supported by all of known devices, EXCEPT iMX6!      
  // (Shader program can't be linked due of size)         
  kGL2DCanvasOperationType_DrawRougierDashLine            = 13, 
                                                          
  // Draw line marks operation                            
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawLineMarks                  = 14,
                                                          
  // Draw textured line operation                         
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawTexturedLine               = 15,
                                                          
  // Draw simple text operation                           
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawSimpleText                 = 16,
                                                          
  // Draw bordered text operation                         
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawBorderedText               = 17,
                                                          
  // Draw texts collection operation                      
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawTextsCollection            = 18,
                                                          
  // Draw Latin1 texts operation                          
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawLatin1Texts                = 19,
                                                          
  // Draw Latin1 bordered texts operation                 
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawLatin1BorderedTexts        = 20,
                                                          
  // Draw simple pattern operation                        
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawSimplePattern              = 21,
                                                          
  // Draw staggered pattern operation                     
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawStaggeredPattern           = 22,
                                                          
  // Draw filled circles operation                        
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawFilledCircles              = 23,
                                                          
  // Draw thin solid pivot point based line operation     
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawThinSolidPivotPointLine    = 24,
                                                          
  // Draw indexed texture with 256 colors palette         
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawIndexedTexture_256_Colors  = 25,
                                                          
  // Draw 8 bits radar image operation
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawRadarImage_8_bits          = 26,
 
  // Draw 8 bits texture based radar image operation
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawRadarImage_Tex_8_bits      = 27,
 
  // Draw scalebar operation
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawScalebar                   = 28,
 
  // Draw textures to texture
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawTexturesToTexture          = 29,
 
  // Draw text boxes operation                          
  // Supported by all of known devices so far             
  kGL2DCanvasOperationType_DrawTextBoxes                  = 30,
 
  // Get texture bits operation                           
  // Depends of GL platform/GL or GLES2/device            
  kGL2DCanvasOperationType_GetTextureBits_RGBA            = 31, // Get RGBA texture bits
  kGL2DCanvasOperationType_GetTextureBits_BGRA            = 32, // Get BGRA texture bits
  kGL2DCanvasOperationType_GetTextureBits_RGB             = 33, // Get RGB texture bits
  kGL2DCanvasOperationType_GetTextureBits_RGB16           = 34, // Get RGB16 texture bits
  kGL2DCanvasOperationType_GetTextureBits_Gray            = 35, // Get GrayScale texture bits
 
  // Clone texture operation                              
  // Depends of GL platform/GL or GLES2/device            
  kGL2DCanvasOperationType_CloneTexture_RGBA              = 36, // Clone RGBA texture
  kGL2DCanvasOperationType_CloneTexture_BGRA              = 37, // Clone BGRA texture
  kGL2DCanvasOperationType_CloneTexture_RGB               = 38, // Clone RGB texture
  kGL2DCanvasOperationType_CloneTexture_RGB16             = 39, // Clone RGB16 texture
 
  // Copy texture operation                               
  kGL2DCanvasOperationType_CopyTexture_RGBA =                   // Copy RGBA texture
    kGL2DCanvasOperationType_CloneTexture_RGBA,           
  kGL2DCanvasOperationType_CopyTexture_BGRA =                   // Copy BGRA texture
    kGL2DCanvasOperationType_CloneTexture_BGRA,           
  kGL2DCanvasOperationType_CopyTexture_RGB =                    // Copy RGB texture
    kGL2DCanvasOperationType_CloneTexture_RGB,            
  kGL2DCanvasOperationType_CopyTexture_RGB16 =                  // Copy RGB16 texture
    kGL2DCanvasOperationType_CloneTexture_RGB16,          
  kGL2DCanvasOperationType_CopyTexture_Gray               = 40, // Copy GrayScale texture
 
  // R8/A8 textures support                               
  kGL2DCanvasOperationType_CanCreateR8Texture             = 41, // Can create R8 (GL_RED) texture
  kGL2DCanvasOperationType_CanCreateA8Texture             = 42, // Can create A8 (GL_ALPHA) texture
  kGL2DCanvasOperationType_CanBindR8TextureToFBO          = 43, // Can bind R8 texture to FBO (can render to R8 texture)
  kGL2DCanvasOperationType_CanBindA8TextureToFBO          = 44, // Can bind A8 texture to FBO (can render to A8 texture)
  kGL2DCanvasOperationType_CanCopyR8ToR8                  = 45, // Can copy R8 texture to R8 texture
  kGL2DCanvasOperationType_CanCopyA8ToA8                  = 46, // Can copy A8 texture to A8 texture
  kGL2DCanvasOperationType_CopyTexture_R8 =                     // Copy R8 texture
    kGL2DCanvasOperationType_CanCopyR8ToR8,               
  kGL2DCanvasOperationType_CopyTexture_A8 =                     // Copy A8 texture
    kGL2DCanvasOperationType_CanCopyA8ToA8,               
 
  // Clipping texture support                             
  kGL2DCanvasOperationType_CanCreateClippingTexture       = 47, // Can create clipping texture
  kGL2DCanvasOperationType_CanUseClippingTexture          = 48, // Can use clipping texture
 
  // Directional shadows for 3D objects support
  kGL2DCanvasOperationType_CanDrawDirectionalShadowsFor3D = 49, // Can draw directional shadows for 3D objects, like mesh 3D
 
  // First/last operation type
  kGL2DCanvasOperationType_First = kGL2DCanvasOperationType_Clipping,
  kGL2DCanvasOperationType_Last  = kGL2DCanvasOperationType_CanDrawDirectionalShadowsFor3D,
};
 
class IGL2DCaps : public ISDKProperties
{
public:
  virtual void SDK_CALLTYPE Dump() const throw() = 0;
 
  virtual IGL2DCanvasSP SDK_CALLTYPE GetParent() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetVendorName(
    SDKString& vendor_name) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetRendererName(
    SDKString& renderer_name) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetGlVersion(
    SDKString& gl_version) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetGlNumericVersion(
    SDKUInt32& major, SDKUInt32& minor) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetGlSlVersion(
    SDKString& glsl_version) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetGlSlNumericVersion(
    SDKUInt32& major, SDKUInt32& minor) const throw() = 0;
  virtual GL2DGpuType SDK_CALLTYPE GetGpuType() const throw() = 0;
  virtual GL2DGpuVendor SDK_CALLTYPE GetGpuVendor() const throw() = 0;
 
  virtual bool SDK_CALLTYPE IsGpuHasLowAccuracyForLongLineSegments() const throw() = 0;
 
  virtual SDKUInt32 SDK_CALLTYPE GetMaxTextureSize() const throw() = 0;
 
  virtual SDKUInt32 SDK_CALLTYPE GetMaxRenderBufferSize() const throw() = 0;
 
  virtual bool SDK_CALLTYPE GetTextureSizeIsPowerOfTwo() const throw() = 0;
 
  virtual bool SDK_CALLTYPE GetBGRASupport() const throw() = 0;
 
  inline bool SDK_CALLTYPE CanCreateR8Textures() const
  {
    return IsCanvasOperationSupported(
      kGL2DCanvasOperationType_CanCreateR8Texture);
  }
  inline bool SDK_CALLTYPE CanCreateA8Textures() const
  {
    return IsCanvasOperationSupported(
      kGL2DCanvasOperationType_CanCreateA8Texture);
  }
  inline bool SDK_CALLTYPE CanCreateGrayscaleTextures() const
  { return CanCreateR8Textures() || CanCreateA8Textures(); }
 
  inline bool SDK_CALLTYPE CanBindR8TextureToFBO() const
  {
    return IsCanvasOperationSupported(
      kGL2DCanvasOperationType_CanBindR8TextureToFBO);
  }
  inline bool SDK_CALLTYPE CanBindA8TextureToFBO() const
  {
    return IsCanvasOperationSupported(
      kGL2DCanvasOperationType_CanBindA8TextureToFBO);
  }
  inline bool SDK_CALLTYPE CanBindGrayscaleTextureToFBO() const
  { return CanBindR8TextureToFBO() || CanBindA8TextureToFBO(); }
 
  inline bool SDK_CALLTYPE CanCopyR8TextureToR8Texture() const
  { return IsCanvasOperationSupported(kGL2DCanvasOperationType_CanCopyR8ToR8); }
  inline bool SDK_CALLTYPE CanCopyA8TextureToA8Texture() const
  { return IsCanvasOperationSupported(kGL2DCanvasOperationType_CanCopyA8ToA8); }
  inline bool SDK_CALLTYPE CanCopyGrayscaleTextureToGrayscaleTexture() const
  { return IsCanvasOperationSupported(kGL2DCanvasOperationType_CopyTexture_Gray); }
 
  virtual bool SDK_CALLTYPE GetStencil8Support() const throw() = 0;
  virtual bool SDK_CALLTYPE GetDepth24Support() const throw() = 0;
  virtual bool SDK_CALLTYPE GetPackedDepthStencilSupport() const throw() = 0;
  virtual bool SDK_CALLTYPE GetDepthTextureSupport() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetCurrentFBOStencilBits() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetCurrentFBOAlphaBits() const throw() = 0;
 
  virtual SDKUInt64 SDK_CALLTYPE GetMaxVerticesCount() const throw() = 0;
  virtual SDKUInt64 SDK_CALLTYPE GetMaxIndexesCount() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetMaxIndexValue() const throw() = 0;
 
  virtual SDKUInt32 SDK_CALLTYPE GetMaxNumberOfClippingMeshes() const throw() = 0;
 
  virtual float SDK_CALLTYPE GetMinSimpleLineWidth() const throw() = 0;
  virtual float SDK_CALLTYPE GetMaxSimpleLineWidth() const throw() = 0;
  
  virtual SDKUInt32 SDK_CALLTYPE GetMaxVertexShaderAttributesCount() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetMaxVertexShaderUniformsCount() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetMaxVertexShaderTexturesCount() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetMaxShaderVaryingVectorsCount() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetMaxFragmentShaderUniformsCount() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetMaxFragmentShaderTexturesCount() const throw() = 0;
 
  virtual SDKUInt32 SDK_CALLTYPE GetGLSLFloatPrecisionInVertexShader() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetGLSLFloatPrecisionInFragmentShader() const throw() = 0;
  inline SDKUInt32 SDK_CALLTYPE GetGLSLFloatPrecision() const
  {
    const SDKUInt32 vertex = GetGLSLFloatPrecisionInVertexShader();
    const SDKUInt32 fragment = GetGLSLFloatPrecisionInFragmentShader();
    return vertex < fragment ? vertex : fragment;
  }
 
  virtual bool SDK_CALLTYPE IsGlExtensionSupported(
    const SDKString& extension_name) const throw() = 0;
 
  virtual bool SDK_CALLTYPE IsCanvasOperationSupported(
    const GL2DCanvasOperationType& type) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IGL2DCaps)
  SDK_END_INTERFACE(IGL2DCaps)
};
SDK_DECLARE_IID(IGL2DCaps)
 
SDK_GL2D_END_NAMESPACE
 
#endif // SDK_GL2D_CAPS_INTERFACE_H_