Files
odfstudio/include/vcl/opengl/OpenGLHelper.hxx
T
Thorsten Behrens 493ae7a6bb replace usage of blacklist with denylist
.. and a few cases of instead doing blacklist->excludelist where that
made more sense.

Background and motivation:
  https://tools.ietf.org/html/draft-knodel-terminology-02

[API CHANGE] officecfg::Office::Canvas::DeviceBlacklist -> DeviceDenylist
[API CHANGE] officecfg::Office::Canvas::BlacklistCurrentDevice -> DenylistCurrentDevice
[API CHANGE] officecfg::Office::Common::Misc::OpenCLBlackList -> OpenCLDenyList

Change-Id: Ia35e25496bf0cc0692d5de4cb66bfc232d3a869e
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/98180
Tested-by: Thorsten Behrens <Thorsten.Behrens@CIB.de>
Reviewed-by: Thorsten Behrens <Thorsten.Behrens@CIB.de>
2020-07-10 01:34:54 +02:00

127 lines
4.6 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#ifndef INCLUDED_VCL_OPENGL_OPENGLHELPER_HXX
#define INCLUDED_VCL_OPENGL_OPENGLHELPER_HXX
#include <epoxy/gl.h>
#include <sal/detail/log.h>
#include <vcl/dllapi.h>
#include <vcl/bitmapex.hxx>
#include <rtl/ustring.hxx>
#include <sstream>
/// Helper to do a SAL_INFO as well as a GL log.
#define VCL_GL_INFO(stream) \
do { \
if (SAL_DETAIL_ENABLE_LOG_INFO && OpenGLHelper::isVCLOpenGLEnabled()) \
{ \
::std::ostringstream detail_stream; \
detail_stream << stream; \
OpenGLHelper::debugMsgStream(detail_stream); \
} \
} while (false)
/// Helper to do a SAL_WARN as well as a GL log.
#define VCL_GL_WARN(stream) \
do { \
if (SAL_DETAIL_ENABLE_LOG_INFO && OpenGLHelper::isVCLOpenGLEnabled()) \
{ \
::std::ostringstream detail_stream; \
detail_stream << stream; \
OpenGLHelper::debugMsgStreamWarn(detail_stream); \
} \
} while (false)
// All member functions static and VCL_DLLPUBLIC. Basically a glorified namespace.
struct VCL_DLLPUBLIC OpenGLHelper
{
OpenGLHelper() = delete; // Should not be instantiated
public:
static OString GetDigest(const OUString& rVertexShaderName, const OUString& rFragmentShaderName, const OString& preamble );
static GLint LoadShaders(const OUString& rVertexShaderName, const OUString& rFragmentShaderName, const OUString& rGeometryShaderName, const OString& preamble, const OString& rDigest );
static GLint LoadShaders(const OUString& rVertexShaderName, const OUString& rFragmentShaderName, const OString& preamble, const OString& rDigest );
static GLint LoadShaders(const OUString& rVertexShaderName, const OUString& rFragmentShaderName, const OUString& rGeometryShaderName);
static GLint LoadShaders(const OUString& rVertexShaderName, const OUString& rFragmentShaderName);
/**
* The caller is responsible for allocating the memory for the buffer before calling
* this method. The buffer size is assumed to be 4*width*height and the format
* to be OptimalBufferFormat().
**/
static BitmapEx ConvertBufferToBitmapEx(const sal_uInt8* const pBuffer, long nWidth, long nHeight);
/**
* Returns the optimal buffer format for OpenGL (GL_BGRA or GL_RGBA).
**/
static GLenum OptimalBufferFormat();
static void renderToFile(long nWidth, long nHeight, const OUString& rFileName);
static const char* GLErrorString(GLenum errorCode);
/**
* The caller is responsible for deleting the buffer objects identified by
* nFramebufferId, nRenderbufferDepthId and nRenderbufferColorId.
* This create a buffer for rendering to texture and should be freed with
* glDeleteTextures.
*
* @param nWidth Width of frame
* @param nHeight Height of frame
* @param nFramebufferId FrameBuffer ID
* @param nRenderbufferDepthId RenderBuffer's depth ID
* @param nRenderbufferColorId RenderBuffer's color ID
*/
static void createFramebuffer(long nWidth, long nHeight, GLuint& nFramebufferId,
GLuint& nRenderbufferDepthId, GLuint& nRenderbufferColorId);
/// Get OpenGL version (needs a context)
static float getGLVersion();
static void checkGLError(const char* aFile, size_t nLine);
/**
* Insert a glDebugMessage into the queue - helpful for debugging
* with apitrace to annotate the output and correlate it with code.
*/
#if defined __GNUC__
__attribute__ ((format (printf, 2, 3)))
#endif
static void debugMsgPrint(const int nType, const char *pFormat, ...);
static void debugMsgStream(std::ostringstream const &pStream);
static void debugMsgStreamWarn(std::ostringstream const &pStream);
/**
* checks if the device/driver pair is on our OpenGL denylist
*/
static bool isDeviceDenylisted();
/**
* checks if the system supports all features that are necessary for the OpenGL VCL support
*/
static bool supportsVCLOpenGL();
/**
* Returns true if VCL has OpenGL rendering enabled
*/
static bool isVCLOpenGLEnabled();
};
#ifdef SAL_LOG_WARN
#define CHECK_GL_ERROR() OpenGLHelper::checkGLError(__FILE__, __LINE__)
#else
#define CHECK_GL_ERROR() do { } while (false)
#endif
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */