include/vcl/opengl/OpenGLHelper.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #ifndef INCLUDED_VCL_OPENGL_OPENGLHELPER_HXX
  11 #define INCLUDED_VCL_OPENGL_OPENGLHELPER_HXX
  12
  13 #include <GL/glew.h>
  14 #include <sal/log.hxx>
  15 #include <vcl/dllapi.h>
  16 #include <vcl/bitmapex.hxx>
  17
  18 #include <rtl/ustring.hxx>
  19
  20 #if defined UNX && !defined MACOSX && !defined IOS && !defined ANDROID && !defined(LIBO_HEADLESS)
  21 #  include <prex.h>
  22 #  include "GL/glxew.h"
  23 #  include <postx.h>
  24 #endif
  25
  26 /// Helper to do a SAL_INFO as well as a GL log.
  27 #define VCL_GL_INFO(area,stream) \
  28     do { \
  29         if (SAL_DETAIL_ENABLE_LOG_INFO) \
  30         { \
  31             ::std::ostringstream detail_stream; \
  32             detail_stream << stream;            \
  33             OpenGLHelper::debugMsgStream((area),detail_stream); \
  34         } \
  35     } while (false)
  36
  37 class VCL_DLLPUBLIC OpenGLHelper
  38 {
  39     OpenGLHelper() SAL_DELETED_FUNCTION; // Should not be instantiated
  40
  41 public:
  42
  43     static rtl::OString GetDigest(const OUString& rVertexShaderName, const OUString& rFragmentShaderName, const rtl::OString& preamble = "" );
  44
  45     static GLint LoadShaders(const OUString& rVertexShaderName, const OUString& rFragmentShaderName, const rtl::OString& preamble = "", const rtl::OString& rDigest = "" );
  46
  47     /**
  48      * The caller is responsible for allocate the memory for the RGBA buffer, before call
  49      * this method. RGBA buffer size is assumed to be 4*width*height.
  50      * Since OpenGL uses textures flipped relative to BitmapEx storage this method
  51      * also adds the possibility to mirror the bitmap vertically at the same time.
  52     **/
  53     static void ConvertBitmapExToRGBATextureBuffer(const BitmapEx& rBitmapEx, sal_uInt8* o_pRGBABuffer, const bool bFlip = false);
  54     static BitmapEx ConvertBGRABufferToBitmapEx(const sal_uInt8* const pBuffer, long nWidth, long nHeight);
  55     static void renderToFile(long nWidth, long nHeight, const OUString& rFileName);
  56
  57     static const char* GLErrorString(GLenum errorCode);
  58
  59     /**
  60      * The caller is responsible for deleting the buffer objects identified by
  61      * nFramebufferId, nRenderbufferDepthId and nRenderbufferColorId
  62      * @param bRenderbuffer true => off-screen rendering, false => rendering to texture
  63      *          This also affects whether to free with glDeleteRenderbuffers or glDeleteTextures
  64      */
  65     static void createFramebuffer(long nWidth, long nHeight, GLuint& nFramebufferId,
  66             GLuint& nRenderbufferDepthId, GLuint& nRenderbufferColorId, bool bRenderbuffer = true);
  67
  68     /// Get OpenGL version (needs a context)
  69     static float getGLVersion();
  70
  71     static void checkGLError(const char* aFile, size_t nLine);
  72
  73     /**
  74      * Insert a glDebugMessage into the queue - helpful for debugging
  75      * with apitrace to annotate the output and correlate it with code.
  76      */
  77     static void debugMsgPrint(const char *pArea, const char *pFormat, ...);
  78     static void debugMsgStream(const char *pArea, std::ostringstream const &pStream);
  79
  80     /**
  81      * checks if the device/driver pair is on our OpenGL blacklist
  82      */
  83     static bool isDeviceBlacklisted();
  84
  85     /**
  86      * checks if the system supports all features that are necessary for the OpenGL VCL support
  87      */
  88     static bool supportsVCLOpenGL();
  89
  90     /**
  91      * Returns true if VCL has OpenGL rendering enabled
  92      */
  93     static bool isVCLOpenGLEnabled();
  94
  95 #if defined UNX && !defined MACOSX && !defined IOS && !defined ANDROID && !defined(LIBO_HEADLESS)
  96     static bool GetVisualInfo(Display* pDisplay, int nScreen, XVisualInfo& rVI);
  97     static GLXFBConfig GetPixmapFBConfig( Display* pDisplay, bool& bInverted );
  98 #endif
  99 };
 100
 101 #define CHECK_GL_ERROR() OpenGLHelper::checkGLError(__FILE__, __LINE__)
 102
 103 #endif
 104
 105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */