mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-10 18:51:21 +03:00
737e9a8da4
OpenGl_AspectsTextureSet now appends Sprite texture to the end of texture set. OpenGl_Context::init() - fixed usage of GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS on too old GL context. Default sampler names occSampler0, occActiveSampler and occSamplerBaseColor are now excluded from header with common declarations for build-in GLSL programs. OpenGl_ShaderObject::LoadAndCompile() and OpenGl_ShaderProgram::Link() now includes program Id within error log. OpenGl_ShaderManager now supports mapping texture onto point primitive within built-in programs (texture transformation is ignored).
527 lines
18 KiB
C++
Executable File
527 lines
18 KiB
C++
Executable File
// Created on: 2013-09-19
|
|
// Created by: Denis BOGOLEPOV
|
|
// Copyright (c) 2013-2014 OPEN CASCADE SAS
|
|
//
|
|
// This file is part of Open CASCADE Technology software library.
|
|
//
|
|
// This library is free software; you can redistribute it and/or modify it under
|
|
// the terms of the GNU Lesser General Public License version 2.1 as published
|
|
// by the Free Software Foundation, with special exception defined in the file
|
|
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
|
|
// distribution for complete text of the license and disclaimer of any warranty.
|
|
//
|
|
// Alternatively, this file may be used under the terms of Open CASCADE
|
|
// commercial license or contractual agreement.
|
|
|
|
#include <Graphic3d_ShaderObject.hxx>
|
|
#include <Message_Messenger.hxx>
|
|
#include <OpenGl_Context.hxx>
|
|
#include <OpenGl_ShaderObject.hxx>
|
|
#include <OSD_File.hxx>
|
|
#include <OSD_Path.hxx>
|
|
#include <OSD_Process.hxx>
|
|
#include <OSD_Protection.hxx>
|
|
#include <Standard_Assert.hxx>
|
|
#include <TCollection_AsciiString.hxx>
|
|
#include <TCollection_ExtendedString.hxx>
|
|
|
|
#ifdef _WIN32
|
|
#include <malloc.h> // for alloca()
|
|
#endif
|
|
|
|
IMPLEMENT_STANDARD_RTTIEXT(OpenGl_ShaderObject,OpenGl_Resource)
|
|
|
|
//! Puts line numbers to the output of GLSL program source code.
|
|
static TCollection_AsciiString putLineNumbers (const TCollection_AsciiString& theSource)
|
|
{
|
|
std::stringstream aStream;
|
|
theSource.Print (aStream);
|
|
std::string aLine;
|
|
Standard_Integer aLineNumber = 1;
|
|
TCollection_AsciiString aResultSource;
|
|
while (std::getline (aStream, aLine))
|
|
{
|
|
TCollection_AsciiString anAsciiString = TCollection_AsciiString (aLine.c_str());
|
|
anAsciiString.Prepend (TCollection_AsciiString ("\n") + TCollection_AsciiString (aLineNumber) + ": ");
|
|
aResultSource += anAsciiString;
|
|
aLineNumber++;
|
|
}
|
|
return aResultSource;
|
|
}
|
|
|
|
//! Return GLSL shader stage title.
|
|
static TCollection_AsciiString getShaderTypeString (GLenum theType)
|
|
{
|
|
switch (theType)
|
|
{
|
|
case GL_VERTEX_SHADER: return "Vertex Shader";
|
|
case GL_FRAGMENT_SHADER: return "Fragment Shader";
|
|
case GL_GEOMETRY_SHADER: return "Geometry Shader";
|
|
case GL_TESS_CONTROL_SHADER: return "Tessellation Control Shader";
|
|
case GL_TESS_EVALUATION_SHADER: return "Tessellation Evaluation Shader";
|
|
case GL_COMPUTE_SHADER: return "Compute Shader";
|
|
}
|
|
return "Shader";
|
|
}
|
|
|
|
// =======================================================================
|
|
// function : CreateFromSource
|
|
// purpose :
|
|
// =======================================================================
|
|
Handle(Graphic3d_ShaderObject) OpenGl_ShaderObject::CreateFromSource (TCollection_AsciiString& theSource,
|
|
Graphic3d_TypeOfShaderObject theType,
|
|
const ShaderVariableList& theUniforms,
|
|
const ShaderVariableList& theStageInOuts,
|
|
const TCollection_AsciiString& theInName,
|
|
const TCollection_AsciiString& theOutName,
|
|
Standard_Integer theNbGeomInputVerts)
|
|
{
|
|
if (theSource.IsEmpty())
|
|
{
|
|
return Handle(Graphic3d_ShaderObject)();
|
|
}
|
|
|
|
TCollection_AsciiString aSrcUniforms, aSrcInOuts, aSrcInStructs, aSrcOutStructs;
|
|
for (ShaderVariableList::Iterator anUniformIter (theUniforms); anUniformIter.More(); anUniformIter.Next())
|
|
{
|
|
const ShaderVariable& aVar = anUniformIter.Value();
|
|
if ((aVar.Stages & theType) != 0)
|
|
{
|
|
aSrcUniforms += TCollection_AsciiString("\nuniform ") + aVar.Name + ";";
|
|
}
|
|
}
|
|
for (ShaderVariableList::Iterator aVarListIter (theStageInOuts); aVarListIter.More(); aVarListIter.Next())
|
|
{
|
|
const ShaderVariable& aVar = aVarListIter.Value();
|
|
Standard_Integer aStageLower = IntegerLast(), aStageUpper = IntegerFirst();
|
|
Standard_Integer aNbStages = 0;
|
|
for (Standard_Integer aStageIter = Graphic3d_TOS_VERTEX; aStageIter <= (Standard_Integer )Graphic3d_TOS_COMPUTE; aStageIter = aStageIter << 1)
|
|
{
|
|
if ((aVar.Stages & aStageIter) != 0)
|
|
{
|
|
++aNbStages;
|
|
aStageLower = Min (aStageLower, aStageIter);
|
|
aStageUpper = Max (aStageUpper, aStageIter);
|
|
}
|
|
}
|
|
if ((Standard_Integer )theType < aStageLower
|
|
|| (Standard_Integer )theType > aStageUpper)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
const Standard_Boolean hasGeomStage = theNbGeomInputVerts > 0
|
|
&& aStageLower < Graphic3d_TOS_GEOMETRY
|
|
&& aStageUpper >= Graphic3d_TOS_GEOMETRY;
|
|
const Standard_Boolean isAllStagesVar = aStageLower == Graphic3d_TOS_VERTEX
|
|
&& aStageUpper == Graphic3d_TOS_FRAGMENT;
|
|
if (hasGeomStage
|
|
|| !theInName.IsEmpty()
|
|
|| !theOutName.IsEmpty())
|
|
{
|
|
if (aSrcInStructs.IsEmpty()
|
|
&& aSrcOutStructs.IsEmpty()
|
|
&& isAllStagesVar)
|
|
{
|
|
if (theType == aStageLower)
|
|
{
|
|
aSrcOutStructs = "\nout VertexData\n{";
|
|
}
|
|
else if (theType == aStageUpper)
|
|
{
|
|
aSrcInStructs = "\nin VertexData\n{";
|
|
}
|
|
else // requires theInName/theOutName
|
|
{
|
|
aSrcInStructs = "\nin VertexData\n{";
|
|
aSrcOutStructs = "\nout VertexData\n{";
|
|
}
|
|
}
|
|
}
|
|
|
|
if (isAllStagesVar
|
|
&& (!aSrcInStructs.IsEmpty()
|
|
|| !aSrcOutStructs.IsEmpty()))
|
|
{
|
|
if (!aSrcInStructs.IsEmpty())
|
|
{
|
|
aSrcInStructs += TCollection_AsciiString("\n ") + aVar.Name + ";";
|
|
}
|
|
if (!aSrcOutStructs.IsEmpty())
|
|
{
|
|
aSrcOutStructs += TCollection_AsciiString("\n ") + aVar.Name + ";";
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if (theType == aStageLower)
|
|
{
|
|
aSrcInOuts += TCollection_AsciiString("\nTHE_SHADER_OUT ") + aVar.Name + ";";
|
|
}
|
|
else if (theType == aStageUpper)
|
|
{
|
|
aSrcInOuts += TCollection_AsciiString("\nTHE_SHADER_IN ") + aVar.Name + ";";
|
|
}
|
|
}
|
|
}
|
|
|
|
if (theType == Graphic3d_TOS_GEOMETRY)
|
|
{
|
|
aSrcUniforms.Prepend (TCollection_AsciiString()
|
|
+ "\nlayout (triangles) in;"
|
|
"\nlayout (triangle_strip, max_vertices = " + theNbGeomInputVerts + ") out;");
|
|
}
|
|
if (!aSrcInStructs.IsEmpty()
|
|
&& theType == Graphic3d_TOS_GEOMETRY)
|
|
{
|
|
aSrcInStructs += TCollection_AsciiString ("\n} ") + theInName + "[" + theNbGeomInputVerts + "];";
|
|
}
|
|
else if (!aSrcInStructs.IsEmpty())
|
|
{
|
|
aSrcInStructs += "\n}";
|
|
if (!theInName.IsEmpty())
|
|
{
|
|
aSrcInStructs += " ";
|
|
aSrcInStructs += theInName;
|
|
}
|
|
aSrcInStructs += ";";
|
|
}
|
|
if (!aSrcOutStructs.IsEmpty())
|
|
{
|
|
aSrcOutStructs += "\n}";
|
|
if (!theOutName.IsEmpty())
|
|
{
|
|
aSrcOutStructs += " ";
|
|
aSrcOutStructs += theOutName;
|
|
}
|
|
aSrcOutStructs += ";";
|
|
}
|
|
|
|
theSource.Prepend (aSrcUniforms + aSrcInStructs + aSrcOutStructs + aSrcInOuts);
|
|
return Graphic3d_ShaderObject::CreateFromSource (theType, theSource);
|
|
}
|
|
|
|
// =======================================================================
|
|
// function : OpenGl_ShaderObject
|
|
// purpose : Creates uninitialized shader object
|
|
// =======================================================================
|
|
OpenGl_ShaderObject::OpenGl_ShaderObject (GLenum theType)
|
|
: myType (theType),
|
|
myShaderID (NO_SHADER)
|
|
{
|
|
//
|
|
}
|
|
|
|
// =======================================================================
|
|
// function : ~OpenGl_ShaderObject
|
|
// purpose : Releases resources of shader object
|
|
// =======================================================================
|
|
OpenGl_ShaderObject::~OpenGl_ShaderObject()
|
|
{
|
|
Release (NULL);
|
|
}
|
|
|
|
// =======================================================================
|
|
// function : LoadAndCompile
|
|
// purpose :
|
|
// =======================================================================
|
|
Standard_Boolean OpenGl_ShaderObject::LoadAndCompile (const Handle(OpenGl_Context)& theCtx,
|
|
const TCollection_AsciiString& theId,
|
|
const TCollection_AsciiString& theSource,
|
|
bool theIsVerbose,
|
|
bool theToPrintSource)
|
|
{
|
|
if (!theIsVerbose)
|
|
{
|
|
return LoadSource (theCtx, theSource)
|
|
&& Compile (theCtx);
|
|
}
|
|
|
|
if (!LoadSource (theCtx, theSource))
|
|
{
|
|
if (theToPrintSource)
|
|
{
|
|
theCtx->PushMessage (GL_DEBUG_SOURCE_APPLICATION, GL_DEBUG_TYPE_ERROR, 0, GL_DEBUG_SEVERITY_HIGH, theSource);
|
|
}
|
|
theCtx->PushMessage (GL_DEBUG_SOURCE_APPLICATION, GL_DEBUG_TYPE_ERROR, 0, GL_DEBUG_SEVERITY_HIGH,
|
|
TCollection_AsciiString ("Error! Failed to set ") + getShaderTypeString (myType) + " [" + theId + "] source");
|
|
return false;
|
|
}
|
|
|
|
if (!Compile (theCtx))
|
|
{
|
|
if (theToPrintSource)
|
|
{
|
|
theCtx->PushMessage (GL_DEBUG_SOURCE_APPLICATION, GL_DEBUG_TYPE_ERROR, 0, GL_DEBUG_SEVERITY_HIGH, putLineNumbers (theSource));
|
|
}
|
|
TCollection_AsciiString aLog;
|
|
FetchInfoLog (theCtx, aLog);
|
|
if (aLog.IsEmpty())
|
|
{
|
|
aLog = "Compilation log is empty.";
|
|
}
|
|
theCtx->PushMessage (GL_DEBUG_SOURCE_APPLICATION, GL_DEBUG_TYPE_ERROR, 0, GL_DEBUG_SEVERITY_HIGH,
|
|
TCollection_AsciiString ("Failed to compile ") + getShaderTypeString (myType) + " [" + theId + "]. Compilation log:\n" + aLog);
|
|
return false;
|
|
}
|
|
else if (theCtx->caps->glslWarnings)
|
|
{
|
|
TCollection_AsciiString aLog;
|
|
FetchInfoLog (theCtx, aLog);
|
|
if (!aLog.IsEmpty()
|
|
&& !aLog.IsEqual ("No errors.\n"))
|
|
{
|
|
theCtx->PushMessage (GL_DEBUG_SOURCE_APPLICATION, GL_DEBUG_TYPE_PORTABILITY, 0, GL_DEBUG_SEVERITY_LOW,
|
|
getShaderTypeString (myType) + " [" + theId + "] compilation log:\n" + aLog);
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
// =======================================================================
|
|
// function : DumpSourceCode
|
|
// purpose :
|
|
// =======================================================================
|
|
void OpenGl_ShaderObject::DumpSourceCode (const Handle(OpenGl_Context)& theCtx,
|
|
const TCollection_AsciiString& theId,
|
|
const TCollection_AsciiString& theSource) const
|
|
{
|
|
theCtx->PushMessage (GL_DEBUG_SOURCE_APPLICATION, GL_DEBUG_TYPE_OTHER, 0, GL_DEBUG_SEVERITY_MEDIUM,
|
|
getShaderTypeString (myType) + " [" + theId + "] source code:\n" + theSource);
|
|
}
|
|
|
|
// =======================================================================
|
|
// function : LoadSource
|
|
// purpose : Loads shader source code
|
|
// =======================================================================
|
|
Standard_Boolean OpenGl_ShaderObject::LoadSource (const Handle(OpenGl_Context)& theCtx,
|
|
const TCollection_AsciiString& theSource)
|
|
{
|
|
if (myShaderID == NO_SHADER)
|
|
{
|
|
return Standard_False;
|
|
}
|
|
|
|
const GLchar* aLines = theSource.ToCString();
|
|
theCtx->core20fwd->glShaderSource (myShaderID, 1, &aLines, NULL);
|
|
return Standard_True;
|
|
}
|
|
|
|
// =======================================================================
|
|
// function : Compile
|
|
// purpose : Compiles the shader object
|
|
// =======================================================================
|
|
Standard_Boolean OpenGl_ShaderObject::Compile (const Handle(OpenGl_Context)& theCtx)
|
|
{
|
|
if (myShaderID == NO_SHADER)
|
|
{
|
|
return Standard_False;
|
|
}
|
|
|
|
// Try to compile shader
|
|
theCtx->core20fwd->glCompileShader (myShaderID);
|
|
|
|
// Check compile status
|
|
GLint aStatus = GL_FALSE;
|
|
theCtx->core20fwd->glGetShaderiv (myShaderID, GL_COMPILE_STATUS, &aStatus);
|
|
return aStatus != GL_FALSE;
|
|
}
|
|
|
|
// =======================================================================
|
|
// function : FetchInfoLog
|
|
// purpose : Fetches information log of the last compile operation
|
|
// =======================================================================
|
|
Standard_Boolean OpenGl_ShaderObject::FetchInfoLog (const Handle(OpenGl_Context)& theCtx,
|
|
TCollection_AsciiString& theLog)
|
|
{
|
|
if (myShaderID == NO_SHADER)
|
|
{
|
|
return Standard_False;
|
|
}
|
|
|
|
// Load information log of the compiler
|
|
GLint aLength = 0;
|
|
theCtx->core20fwd->glGetShaderiv (myShaderID, GL_INFO_LOG_LENGTH, &aLength);
|
|
if (aLength > 0)
|
|
{
|
|
GLchar* aLog = (GLchar*) alloca (aLength);
|
|
memset (aLog, 0, aLength);
|
|
theCtx->core20fwd->glGetShaderInfoLog (myShaderID, aLength, NULL, aLog);
|
|
theLog = aLog;
|
|
}
|
|
|
|
return Standard_True;
|
|
}
|
|
|
|
// =======================================================================
|
|
// function : Create
|
|
// purpose : Creates new empty shader object of specified type
|
|
// =======================================================================
|
|
Standard_Boolean OpenGl_ShaderObject::Create (const Handle(OpenGl_Context)& theCtx)
|
|
{
|
|
if (myShaderID == NO_SHADER
|
|
&& theCtx->core20fwd != NULL)
|
|
{
|
|
myShaderID = theCtx->core20fwd->glCreateShader (myType);
|
|
}
|
|
|
|
return myShaderID != NO_SHADER;
|
|
}
|
|
|
|
// =======================================================================
|
|
// function : Release
|
|
// purpose : Destroys shader object
|
|
// =======================================================================
|
|
void OpenGl_ShaderObject::Release (OpenGl_Context* theCtx)
|
|
{
|
|
if (myShaderID == NO_SHADER)
|
|
{
|
|
return;
|
|
}
|
|
|
|
Standard_ASSERT_RETURN (theCtx != NULL,
|
|
"OpenGl_ShaderObject destroyed without GL context! Possible GPU memory leakage...",);
|
|
|
|
if (theCtx->core20fwd != NULL
|
|
&& theCtx->IsValid())
|
|
{
|
|
theCtx->core20fwd->glDeleteShader (myShaderID);
|
|
}
|
|
myShaderID = NO_SHADER;
|
|
}
|
|
|
|
//! Return GLSL shader stage file extension.
|
|
static const char* getShaderExtension (GLenum theType)
|
|
{
|
|
switch (theType)
|
|
{
|
|
case GL_VERTEX_SHADER: return ".vs";
|
|
case GL_FRAGMENT_SHADER: return ".fs";
|
|
case GL_GEOMETRY_SHADER: return ".gs";
|
|
case GL_TESS_CONTROL_SHADER: return ".tcs";
|
|
case GL_TESS_EVALUATION_SHADER: return ".tes";
|
|
case GL_COMPUTE_SHADER: return ".cs";
|
|
}
|
|
return ".glsl";
|
|
}
|
|
|
|
//! Expand substring with additional tail.
|
|
static void insertSubString (TCollection_AsciiString& theString,
|
|
const char& thePattern,
|
|
const TCollection_AsciiString& theSubstitution)
|
|
{
|
|
const int aSubLen = theSubstitution.Length();
|
|
for (int aCharIter = 1, aNbChars = theString.Length(); aCharIter <= aNbChars; ++aCharIter)
|
|
{
|
|
if (theString.Value (aCharIter) == thePattern)
|
|
{
|
|
theString.Insert (aCharIter + 1, theSubstitution);
|
|
aCharIter += aSubLen;
|
|
aNbChars += aSubLen;
|
|
}
|
|
}
|
|
}
|
|
|
|
//! Dump GLSL shader source code into file.
|
|
static bool dumpShaderSource (const TCollection_AsciiString& theFileName,
|
|
const TCollection_AsciiString& theSource,
|
|
bool theToBeautify)
|
|
{
|
|
OSD_File aFile (theFileName);
|
|
aFile.Build (OSD_WriteOnly, OSD_Protection());
|
|
TCollection_AsciiString aSource = theSource;
|
|
if (theToBeautify)
|
|
{
|
|
insertSubString (aSource, ';', "\n");
|
|
insertSubString (aSource, '{', "\n");
|
|
insertSubString (aSource, '}', "\n");
|
|
}
|
|
if (!aFile.IsOpen())
|
|
{
|
|
Message::DefaultMessenger()->Send (TCollection_AsciiString("Error: File '") + theFileName + "' cannot be opened to save shader", Message_Fail);
|
|
return false;
|
|
}
|
|
|
|
if (aSource.Length() > 0)
|
|
{
|
|
aFile.Write (aSource.ToCString(), aSource.Length());
|
|
}
|
|
aFile.Close();
|
|
Message::DefaultMessenger()->Send (TCollection_AsciiString ("Shader source dumped into '") + theFileName + "'", Message_Warning);
|
|
return true;
|
|
}
|
|
|
|
//! Read GLSL shader source code from file dump.
|
|
static bool restoreShaderSource (TCollection_AsciiString& theSource,
|
|
const TCollection_AsciiString& theFileName)
|
|
{
|
|
OSD_File aFile (theFileName);
|
|
aFile.Open (OSD_ReadOnly, OSD_Protection());
|
|
if (!aFile.IsOpen())
|
|
{
|
|
Message::DefaultMessenger()->Send (TCollection_AsciiString ("File '") + theFileName + "' cannot be opened to load shader", Message_Fail);
|
|
return false;
|
|
}
|
|
|
|
const Standard_Integer aSize = (Standard_Integer )aFile.Size();
|
|
if (aSize > 0)
|
|
{
|
|
theSource = TCollection_AsciiString (aSize, '\0');
|
|
aFile.Read (theSource, aSize);
|
|
}
|
|
aFile.Close();
|
|
Message::DefaultMessenger()->Send (TCollection_AsciiString ("Restored shader dump from '") + theFileName + "'", Message_Warning);
|
|
return true;
|
|
}
|
|
|
|
// =======================================================================
|
|
// function : updateDebugDump
|
|
// purpose :
|
|
// =======================================================================
|
|
Standard_Boolean OpenGl_ShaderObject::updateDebugDump (const Handle(OpenGl_Context)& theCtx,
|
|
const TCollection_AsciiString& theProgramId,
|
|
const TCollection_AsciiString& theFolder,
|
|
Standard_Boolean theToBeautify,
|
|
Standard_Boolean theToReset)
|
|
{
|
|
const TCollection_AsciiString aFileName = theFolder + "/" + theProgramId + getShaderExtension (myType);
|
|
if (!theToReset)
|
|
{
|
|
OSD_File aFile (aFileName);
|
|
if (aFile.Exists())
|
|
{
|
|
const Quantity_Date aDate = aFile.AccessMoment();
|
|
if (aDate > myDumpDate)
|
|
{
|
|
TCollection_AsciiString aNewSource;
|
|
if (restoreShaderSource (aNewSource, aFileName))
|
|
{
|
|
LoadAndCompile (theCtx, theProgramId, aNewSource);
|
|
return Standard_True;
|
|
}
|
|
}
|
|
return Standard_False;
|
|
}
|
|
}
|
|
|
|
bool isDumped = false;
|
|
if (myShaderID != NO_SHADER)
|
|
{
|
|
GLint aLength = 0;
|
|
theCtx->core20fwd->glGetShaderiv (myShaderID, GL_SHADER_SOURCE_LENGTH, &aLength);
|
|
if (aLength > 0)
|
|
{
|
|
TCollection_AsciiString aSource (aLength - 1, '\0');
|
|
theCtx->core20fwd->glGetShaderSource (myShaderID, aLength, NULL, (GLchar* )aSource.ToCString());
|
|
dumpShaderSource (aFileName, aSource, theToBeautify);
|
|
isDumped = true;
|
|
}
|
|
}
|
|
if (!isDumped)
|
|
{
|
|
dumpShaderSource (aFileName, "", false);
|
|
}
|
|
myDumpDate = OSD_Process().SystemDate();
|
|
return Standard_False;
|
|
}
|