C4Shader Class Reference

#include <C4Shader.h>

Public Member Functions
	C4Shader ()
	~C4Shader ()
bool	Initialised () const
GLint	GetUniform (int iUniform) const
bool	HaveUniform (int iUniform) const
GLint	GetAttribute (int iAttribute) const
void	AddDefine (const char *name)
void	AddVertexSlice (int iPos, const char *szText)
void	AddFragmentSlice (int iPos, const char *szText)
void	AddVertexSlices (const char *szWhat, const char *szText, const char *szSource="", int iFileTime=0)
void	AddFragmentSlices (const char *szWhat, const char *szText, const char *szSource="", int iFileTime=0)
bool	LoadFragmentSlices (C4GroupSet *pGroupSet, const char *szFile)
bool	LoadVertexSlices (C4GroupSet *pGroupSet, const char *szFile)
void	SetScriptCategories (const std::vector< std::string > &categories)
bool	Init (const char *szWhat, const char **szUniforms, const char **szAttributes)
bool	Refresh ()
void	ClearSlices ()
void	Clear ()

Static Public Member Functions
static bool	IsLogging ()

Friends
class	C4ShaderCall
class	C4ScriptUniform

Detailed Description

Definition at line 61 of file C4Shader.h.

Constructor & Destructor Documentation

C4Shader()

C4Shader::C4Shader

(

)

Definition at line 47 of file C4Shader.cpp.

    : LastRefresh()
{
 
}

~C4Shader()

C4Shader::~C4Shader

(

)

Definition at line 53 of file C4Shader.cpp.

{
    Clear();
}

References Clear().

Here is the call graph for this function:

Member Function Documentation

AddDefine()

void C4Shader::AddDefine

(

const char *

name

)

Definition at line 65 of file C4Shader.cpp.

{
    StdStrBuf define = FormatString("#define %s", name);
    AddVertexSlice(-1, define.getData());
    AddFragmentSlice(-1, define.getData());
}

References AddFragmentSlice(), AddVertexSlice(), FormatString(), and StdStrBuf::getData().

Referenced by C4DefAdditionalResourcesLoader::AddShaderSlices(), and CStdGL::PrepareSpriteShader().

Here is the call graph for this function:

Here is the caller graph for this function:

AddFragmentSlice()

void C4Shader::AddFragmentSlice	(	int	iPos,
		const char *	szText
	)

Definition at line 77 of file C4Shader.cpp.

{
    AddSlice(FragmentSlices, iPos, szText, nullptr, 0, 0);
}

Referenced by AddDefine().

Here is the caller graph for this function:

AddFragmentSlices()

void C4Shader::AddFragmentSlices	(	const char *	szWhat,
		const char *	szText,
		const char *	szSource = "",
		int	iFileTime = 0
	)

Definition at line 87 of file C4Shader.cpp.

{
    AddSlices(FragmentSlices, szWhat, szText, szSource, iSourceTime);
}

Referenced by C4FoW::GetFramebufShader(), C4FoW::GetRenderShader(), and Refresh().

Here is the caller graph for this function:

AddVertexSlice()

void C4Shader::AddVertexSlice	(	int	iPos,
		const char *	szText
	)

Definition at line 72 of file C4Shader.cpp.

{
    AddSlice(VertexSlices, iPos, szText, nullptr, 0, 0);
}

Referenced by AddDefine().

Here is the caller graph for this function:

AddVertexSlices()

void C4Shader::AddVertexSlices	(	const char *	szWhat,
		const char *	szText,
		const char *	szSource = "",
		int	iFileTime = 0
	)

Definition at line 82 of file C4Shader.cpp.

{
    AddSlices(VertexSlices, szWhat, szText, szSource, iSourceTime);
}

Referenced by C4FoW::GetFramebufShader(), and C4FoW::GetRenderShader().

Here is the caller graph for this function:

Clear()

void C4Shader::Clear

(

)

Definition at line 335 of file C4Shader.cpp.

{
#ifndef USE_CONSOLE
    if (!hProg) return;
    // Need to be detached, then deleted
    glDeleteProgram(hProg);
    hProg = 0;
    // Clear uniform data
    Uniforms.clear();
    Attributes.clear();
#endif
}

Referenced by C4Sky::Clear(), CStdGL::Clear(), CStdGL::PrepareSpriteShader(), and ~C4Shader().

Here is the caller graph for this function:

ClearSlices()

void C4Shader::ClearSlices

(

)

Definition at line 324 of file C4Shader.cpp.

{
    VertexSlices.clear();
    FragmentSlices.clear();
    iTexCoords = 0;
    // Script slices
    ScriptSlicesLoaded = false;
    Categories.clear();
    ScriptShaders.clear();
}

Referenced by C4FoW::GetFramebufShader(), C4FoW::GetRenderShader(), and CStdGL::PrepareSpriteShader().

Here is the caller graph for this function:

GetAttribute()

GLint C4Shader::GetAttribute ( int  iAttribute ) const

inline

Definition at line 127 of file C4Shader.h.

    {
        return iAttribute >= 0 && static_cast<unsigned int>(iAttribute) < Attributes.size() ? Attributes[iAttribute].address : -1;
    }

Referenced by C4LandscapeRenderGL::Draw(), C4ShaderCall::GetAttribute(), and C4FoWRegion::Render().

Here is the caller graph for this function:

GetUniform()

GLint C4Shader::GetUniform ( int  iUniform ) const

inline

Definition at line 117 of file C4Shader.h.

    {
        return iUniform >= 0 && static_cast<unsigned int>(iUniform) < Uniforms.size() ? Uniforms[iUniform].address : -1;
    }

Referenced by HaveUniform(), C4ShaderCall::SetUniform1f(), C4ShaderCall::SetUniform1fv(), C4ShaderCall::SetUniform1i(), C4ShaderCall::SetUniform1iv(), C4ShaderCall::SetUniform1ui(), C4ShaderCall::SetUniform1uiv(), C4ShaderCall::SetUniform2f(), C4ShaderCall::SetUniform2fv(), C4ShaderCall::SetUniform2i(), C4ShaderCall::SetUniform2iv(), C4ShaderCall::Setuniform2ui(), C4ShaderCall::SetUniform2uiv(), C4ShaderCall::SetUniform3f(), C4ShaderCall::SetUniform3fv(), C4ShaderCall::SetUniform3i(), C4ShaderCall::SetUniform3iv(), C4ShaderCall::Setuniform3ui(), C4ShaderCall::SetUniform3uiv(), C4ShaderCall::SetUniform4f(), C4ShaderCall::SetUniform4fv(), C4ShaderCall::SetUniform4i(), C4ShaderCall::SetUniform4iv(), C4ShaderCall::Setuniform4ui(), C4ShaderCall::SetUniform4uiv(), C4ShaderCall::SetUniformMatrix2x3fv(), C4ShaderCall::SetUniformMatrix3x3(), C4ShaderCall::SetUniformMatrix3x3fv(), C4ShaderCall::SetUniformMatrix3x3Transpose(), C4ShaderCall::SetUniformMatrix3x4(), C4ShaderCall::SetUniformMatrix3x4fv(), C4ShaderCall::SetUniformMatrix4x4(), and C4ShaderCall::SetUniformMatrix4x4fv().

Here is the caller graph for this function:

HaveUniform()

bool C4Shader::HaveUniform ( int  iUniform ) const

inline

Definition at line 122 of file C4Shader.h.

    {
        return GetUniform(iUniform) != GLint(-1);
    }

References GetUniform().

Referenced by C4ShaderCall::AllocTexUnit(), C4LandscapeRenderGL::Draw(), C4ShaderCall::SetUniform1f(), C4ShaderCall::SetUniform1fv(), C4ShaderCall::SetUniform1i(), C4ShaderCall::SetUniform1iv(), C4ShaderCall::SetUniform1ui(), C4ShaderCall::SetUniform1uiv(), C4ShaderCall::SetUniform2f(), C4ShaderCall::SetUniform2fv(), C4ShaderCall::SetUniform2i(), C4ShaderCall::SetUniform2iv(), C4ShaderCall::Setuniform2ui(), C4ShaderCall::SetUniform2uiv(), C4ShaderCall::SetUniform3f(), C4ShaderCall::SetUniform3fv(), C4ShaderCall::SetUniform3i(), C4ShaderCall::SetUniform3iv(), C4ShaderCall::Setuniform3ui(), C4ShaderCall::SetUniform3uiv(), C4ShaderCall::SetUniform4f(), C4ShaderCall::SetUniform4fv(), C4ShaderCall::SetUniform4i(), C4ShaderCall::SetUniform4iv(), C4ShaderCall::Setuniform4ui(), C4ShaderCall::SetUniform4uiv(), C4ShaderCall::SetUniformMatrix2x3fv(), C4ShaderCall::SetUniformMatrix3x3(), C4ShaderCall::SetUniformMatrix3x3fv(), C4ShaderCall::SetUniformMatrix3x3Transpose(), C4ShaderCall::SetUniformMatrix3x4(), C4ShaderCall::SetUniformMatrix3x4fv(), C4ShaderCall::SetUniformMatrix4x4(), and C4ShaderCall::SetUniformMatrix4x4fv().

Here is the call graph for this function:

Here is the caller graph for this function:

Init()

bool C4Shader::Init	(	const char *	szWhat,
		const char **	szUniforms,
		const char **	szAttributes
	)

Definition at line 348 of file C4Shader.cpp.

{
    Name.Copy(szWhat);
    LastRefresh = C4TimeMilliseconds::Now();
 
    if (!ScriptSlicesLoaded)
    {
        Categories.emplace_back(szWhat);
        LoadScriptSlices();
    }
 
    StdStrBuf VertexShader = Build(VertexSlices, true),
        FragmentShader = Build(FragmentSlices, true);
 
    // Dump
    if (C4Shader::IsLogging())
    {
        ShaderLogF("******** Vertex shader for %s:", szWhat);
        ShaderLog(VertexShader.getData());
        ShaderLogF("******** Fragment shader for %s:", szWhat);
        ShaderLog(FragmentShader.getData());
    }
 
#ifndef USE_CONSOLE
    // Attempt to create shaders
    const GLuint hVert = Create(GL_VERTEX_SHADER,
                                FormatString("%s vertex shader", szWhat).getData(),
                                VertexShader.getData());
    const GLuint hFrag = Create(GL_FRAGMENT_SHADER,
                                FormatString("%s fragment shader", szWhat).getData(),
                                FragmentShader.getData());
 
    if(!hFrag || !hVert)
    {
        if (hFrag) glDeleteShader(hFrag);
        if (hVert) glDeleteShader(hVert);
        return false;
    }
 
    // Link program
    const GLuint hNewProg = glCreateProgram();
    pGL->ObjectLabel(GL_PROGRAM, hNewProg, -1, szWhat);
    glAttachShader(hNewProg, hVert);
    glAttachShader(hNewProg, hFrag);
    glLinkProgram(hNewProg);
    // Delete vertex and fragment shader after we linked the program
    glDeleteShader(hFrag);
    glDeleteShader(hVert);
 
    // Link successful?
    DumpInfoLog(FormatString("%s shader program", szWhat).getData(), hNewProg, true);
    GLint status;
    glGetProgramiv(hNewProg, GL_LINK_STATUS, &status);
    if(status != GL_TRUE) {
        glDeleteProgram(hNewProg);
        ShaderLogF("  gl: Failed to link %s shader!", szWhat);
        return false;
    }
    ShaderLogF("  gl: %s shader linked successfully", szWhat);
 
    // Everything successful, delete old shader
    if (hProg != 0) glDeleteProgram(hProg);
    hProg = hNewProg;
 
    // Allocate uniform and attribute arrays
    int iUniformCount = 0;
    if (szUniforms != nullptr)
        while (szUniforms[iUniformCount])
            iUniformCount++;
    Uniforms.resize(iUniformCount);
 
    int iAttributeCount = 0;
    if (szAttributes != nullptr)
        while (szAttributes[iAttributeCount])
            iAttributeCount++;
    Attributes.resize(iAttributeCount);
 
    // Get uniform and attribute locations. Note this is expected to fail for a few of them
    // because the respective uniforms got optimized out!
    for (int i = 0; i < iUniformCount; i++) {
        Uniforms[i].address = glGetUniformLocation(hProg, szUniforms[i]);
        Uniforms[i].name = szUniforms[i];
        ShaderLogF("Uniform %s = %d", szUniforms[i], Uniforms[i].address);
    }
 
    for (int i = 0; i < iAttributeCount; i++) {
        Attributes[i].address = glGetAttribLocation(hProg, szAttributes[i]);
        Attributes[i].name = szAttributes[i];
        ShaderLogF("Attribute %s = %d", szAttributes[i], Attributes[i].address);
    }
 
#endif
 
    return true;
}

References StdStrBuf::Copy(), FormatString(), StdStrBuf::getData(), IsLogging(), C4TimeMilliseconds::Now(), CStdGL::ObjectLabel(), pGL, ShaderLog(), and ShaderLogF().

Referenced by C4FoW::GetFramebufShader(), C4FoW::GetRenderShader(), and Refresh().

Here is the call graph for this function:

Here is the caller graph for this function:

Initialised()

bool C4Shader::Initialised ( ) const

inline

Definition at line 106 of file C4Shader.h.

    {
#ifndef USE_CONSOLE
        return hProg != 0;
#else
        return true;
#endif
    }

Referenced by C4LandscapeRenderGL::Draw(), C4FoW::GetFramebufShader(), C4FoW::GetRenderShader(), and StdMeshMaterialProgram::IsCompiled().

Here is the caller graph for this function:

IsLogging()

bool C4Shader::IsLogging ( )

static

Definition at line 665 of file C4Shader.cpp.

{ return Config.Graphics.DebugOpenGL != 0 || !!Application.isEditor; }

References Application, Config, C4ConfigGraphics::DebugOpenGL, C4Config::Graphics, and C4Application::isEditor.

Referenced by Init(), and OpenExtraLogs().

Here is the caller graph for this function:

LoadFragmentSlices()

bool C4Shader::LoadFragmentSlices	(	C4GroupSet *	pGroupSet,
		const char *	szFile
	)

Definition at line 92 of file C4Shader.cpp.

{
    return LoadSlices(FragmentSlices, pGroups, szFile);
}

LoadVertexSlices()

bool C4Shader::LoadVertexSlices	(	C4GroupSet *	pGroupSet,
		const char *	szFile
	)

Definition at line 97 of file C4Shader.cpp.

{
    return LoadSlices(VertexSlices, pGroups, szFile);
}

Refresh()

bool C4Shader::Refresh

(

)

Definition at line 445 of file C4Shader.cpp.

{
    // Update last refresh. Keep a local copy around though to identify added script shaders.
    LastRefresh = C4TimeMilliseconds::Now();
 
    auto next = ScriptShader.GetShaderIDs(Categories);
    std::set<int> toAdd, toRemove;
    std::set_difference(ScriptShaders.begin(), ScriptShaders.end(), next.begin(), next.end(), std::inserter(toRemove, toRemove.end()));
    std::set_difference(next.begin(), next.end(), ScriptShaders.begin(), ScriptShaders.end(), std::inserter(toAdd, toAdd.end()));
    ScriptShaders = next;
 
    auto removeSlices = [&](ShaderSliceList::iterator& pSlice)
    {
        StdCopyStrBuf Source = pSlice->Source;
 
        // Okay, remove all slices that came from this file
        ShaderSliceList::iterator pNext;
        for (; pSlice != FragmentSlices.end(); pSlice = pNext)
        {
            pNext = pSlice; pNext++;
            if (SEqual(pSlice->Source.getData(), Source.getData()))
                FragmentSlices.erase(pSlice);
        }
    };
 
    // Find slices where the source file has updated.
    std::vector<StdCopyStrBuf> sourcesToUpdate;
    for (ShaderSliceList::iterator pSlice = FragmentSlices.begin(); pSlice != FragmentSlices.end(); pSlice++)
        if (pSlice->Source.getLength())
        {
            if (pSlice->Source.BeginsWith("[script "))
            {
                // TODO: Maybe save id instead of parsing the string here.
                int sid = -1;
                sscanf(pSlice->Source.getData(), "[script %d", &sid);
                if (toRemove.find(sid) != toRemove.end())
                    removeSlices(pSlice);
                // Note: script slices don't change, so we don't have to handle updates like for files.
            }
            else if (FileExists(pSlice->Source.getData()) &&
                     FileTime(pSlice->Source.getData()) > pSlice->SourceTime)
            {
                sourcesToUpdate.push_back(pSlice->Source);
                removeSlices(pSlice);
            }
        }
 
    // Anything to do?
    if (toAdd.size() == 0 && toRemove.size() == 0 && sourcesToUpdate.size() == 0)
        return true;
 
    // Process file reloading.
    for (auto& Source : sourcesToUpdate)
    {
        char szParentPath[_MAX_PATH_LEN]; C4Group Group;
        StdStrBuf Shader;
        GetParentPath(Source.getData(),szParentPath);
        if(!Group.Open(szParentPath) ||
           !Group.LoadEntryString(GetFilename(Source.getData()),&Shader) ||
           !Group.Close())
        {
            ShaderLogF("  gl: Failed to refresh %s shader from %s!", Name.getData(), Source.getData());
            return false;
        }
 
        // Load slices
        int iSourceTime = FileTime(Source.getData());
        StdStrBuf WhatSrc = FormatString("file %s", Config.AtRelativePath(Source.getData()));
        AddFragmentSlices(WhatSrc.getData(), Shader.getData(), Source.getData(), iSourceTime);
    }
    
    // Process new script slices.
    for (int id : toAdd)
    {
        LoadScriptSlice(id);
    }
 
#ifndef USE_CONSOLE
    std::vector<const char*> UniformNames(Uniforms.size() + 1);
    for (std::size_t i = 0; i < Uniforms.size(); ++i)
        UniformNames[i] = Uniforms[i].name;
    UniformNames[Uniforms.size()] = nullptr;
 
    std::vector<const char*> AttributeNames(Attributes.size() + 1);
    for (std::size_t i = 0; i < Attributes.size(); ++i)
        AttributeNames[i] = Attributes[i].name;
    AttributeNames[Attributes.size()] = nullptr;
#endif
 
    // Reinitialise
    StdCopyStrBuf What(Name);
    if (!Init(What.getData(), 
#ifndef USE_CONSOLE
        &UniformNames[0],
        &AttributeNames[0]
#else
        nullptr,
        nullptr
#endif
        ))
        return false;
 
    return true;
}

References _MAX_PATH_LEN, AddFragmentSlices(), C4Config::AtRelativePath(), C4Group::Close(), Config, FileExists(), FileTime(), FormatString(), StdStrBuf::getData(), GetFilename(), GetParentPath(), C4ScriptShader::GetShaderIDs(), Init(), C4Group::LoadEntryString(), C4TimeMilliseconds::Now(), C4Group::Open(), ScriptShader, SEqual(), and ShaderLogF().

Here is the call graph for this function:

SetScriptCategories()

void C4Shader::SetScriptCategories

(

const std::vector< std::string > &

categories

)

Definition at line 102 of file C4Shader.cpp.

{
    assert(!ScriptSlicesLoaded && "Can't change shader categories after initialization");
    Categories = categories;
}

Friends And Related Function Documentation

C4ScriptUniform

friend class C4ScriptUniform

friend

Definition at line 64 of file C4Shader.h.

C4ShaderCall

friend class C4ShaderCall

friend

Definition at line 63 of file C4Shader.h.

---

The documentation for this class was generated from the following files:

• C4Shader.h
• C4Shader.cpp
• stub-handle.cpp