scg_internals.h

Go to the documentation of this file.

/*
 * Copyright 2014-2019 Volker Ahlers
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef SCG_INTERNALS_H_
#define SCG_INTERNALS_H_

#include <memory>
#include <string>
#include <utility>
#include "scg_glew.h"

namespace scg {


/*
 * Ensure that required C++11 extensions are supported by compiler.
 * Currently used C++11 features:
 *   auto-typed variables
 *   rvalue references
 *   strongly-typed enumerations
 *   nullptr keyword
 *   range-based for
 *   initializer lists (optional, only in application)
 *   lambda functions (optional, only in application)
 *   library functional: function objects, bind
 *   library memory: smart pointers
 *   library random
 */


#if defined __clang__
// --- Clang ---

// ensure Clang version supports required C++11 features
#if !__has_feature(cxx_auto_type)
#error Clang version supporting C++11 feature auto-typed variables is required.
#endif

#if !__has_feature(cxx_rvalue_references)
#error Clang version supporting C++11 feature rvalue references is required.
#endif

#if !__has_feature(cxx_strong_enums)
#error Clang version supporting C++11 feature strongly-typed enumerations is required.
#endif

#if !__has_feature(cxx_nullptr)
#error Clang version supporting C++11 feature nullptr keyword is required.
#endif

#if !__has_feature(cxx_range_for)
#error Clang version supporting C++11 feature range-based for is required.
#endif

// check which optional C++11 features are available
#if __has_feature(cxx_lambdas)
#define SCG_CPP11_LAMBDA_FUNCTIONS
#endif

#if __has_feature(cxx_generalized_initializers)
#define SCG_CPP11_INITIALIZER_LISTS
#endif

#else
#if defined __GNUC__
// --- GCC ---

// ensure GCC version 4.6 or higher is used
#define SCG_GCC_VERSION (100 * __GNUC__ + __GNUC_MINOR__)
#if SCG_GCC_VERSION < 406   // GCC version < 4.6
#error GCC 4.6 or higher is required.
#endif

// check which optional C++11 features are available
#if SCG_GCC_VERSION >= 405  // GCC version >= 4.5
#define SCG_CPP11_LAMBDA_FUNCTIONS
#endif

#if SCG_GCC_VERSION >= 406  // GCC version >= 4.6
#define SCG_CPP11_INITIALIZER_LISTS
#endif

#else
#if defined _MSC_VER
// --- Visual C++ ---

// ensure Visual C++ compiler version 11.00 (Visual Studio 2012) or higher is used
#if _MSC_VER < 1700   // Visual C++ internal version < 17.00
#error Visual C++ compiler version 11.00 (Visual Studio 2012) or higher is required.
#endif

// check which optional C++11 features are available
#if _MSC_VER >= 1600   // Visual C++ internal version >= 16.00 (Visual Studio 2010)
#define SCG_CPP11_LAMBDA_FUNCTIONS
#endif

#if _MSC_VER >= 1800   // Visual C++ internal version >= 18.00 (Visual Studio 2013)
#define SCG_CPP11_INITIALIZER_LISTS
#endif

#else
// --- neither GCC nor Visual C++ ---

#error Unknown compiler: only Clang, GCC, and Visual C++ are supported.

#endif      // _MSC_VER

#endif      // __GNUC__

#endif      // __clang__


#define SCG_DECLARE_CLASS(TypeName) \
    class TypeName; \
    typedef std::shared_ptr<TypeName> TypeName##SP; \
    typedef std::unique_ptr<TypeName> TypeName##UP;

SCG_DECLARE_CLASS(Animation);
SCG_DECLARE_CLASS(BumpMapCore);
SCG_DECLARE_CLASS(Camera);
SCG_DECLARE_CLASS(CameraController);
SCG_DECLARE_CLASS(Composite);
SCG_DECLARE_CLASS(Controller);
SCG_DECLARE_CLASS(ColorCore);
SCG_DECLARE_CLASS(Core);
SCG_DECLARE_CLASS(CubeMapCore);
SCG_DECLARE_CLASS(GeometryCore);
SCG_DECLARE_CLASS(GeometryCoreFactory);
SCG_DECLARE_CLASS(Group);
SCG_DECLARE_CLASS(InfoTraverser);
SCG_DECLARE_CLASS(KeyboardController);
SCG_DECLARE_CLASS(Leaf);
SCG_DECLARE_CLASS(Light);
SCG_DECLARE_CLASS(LightPosition);
SCG_DECLARE_CLASS(MaterialCore);
SCG_DECLARE_CLASS(MouseController);
SCG_DECLARE_CLASS(Node);
SCG_DECLARE_CLASS(OrthographicCamera);
SCG_DECLARE_CLASS(PerspectiveCamera);
SCG_DECLARE_CLASS(PreTraverser);
SCG_DECLARE_CLASS(Renderer);
SCG_DECLARE_CLASS(RenderState);
SCG_DECLARE_CLASS(RenderTraverser);
SCG_DECLARE_CLASS(ShaderCore);
SCG_DECLARE_CLASS(ShaderCoreFactory);
SCG_DECLARE_CLASS(Shape);
SCG_DECLARE_CLASS(StandardRenderer);
SCG_DECLARE_CLASS(TextureCore);
SCG_DECLARE_CLASS(Texture2DCore);
SCG_DECLARE_CLASS(TransformAnimation);
SCG_DECLARE_CLASS(Transformation);
SCG_DECLARE_CLASS(Traverser);
SCG_DECLARE_CLASS(Viewer);
SCG_DECLARE_CLASS(ViewState);


#define CameraTransformation Error_scg3_CameraTransformation_is_obsolete_Use_Camera_instead


#define SCG_DISALLOW_COPY_AND_ASSIGN(TypeName)  \
    TypeName(const TypeName&);                  \
    void operator=(const TypeName&);


#define SCG_SAVE_AND_SWITCH_PROGRAM(_program, _programOld) \
    GLuint _programOld; \
    glGetIntegerv(GL_CURRENT_PROGRAM, reinterpret_cast<GLint*>(&_programOld)); \
    if (_program != _programOld) { \
      glUseProgram(_program); \
    }


#define SCG_RESTORE_PROGRAM(_program, _programOld) \
    if (_program != _programOld) { \
      glUseProgram(_programOld); \
    }


struct OGLAttrib {
  const GLchar* name;
  GLuint location;
};


struct OGLFragData {
  const GLchar* name;
  GLuint location;
};


struct OGLUniformBlock {
  const GLchar* name;
  GLuint bindingPoint;
};


struct OGLSampler {
  const GLchar* name;
  GLuint texUnit;
};


class OGLConstants {

public:

  static void bindAttribFragDataLocations(GLuint program);

  static void bindUniformBlocks(GLuint program);

  static void bindSamplers(GLuint program);

public:

  // attribute names and locations, defined in internals.cpp
  static const OGLAttrib VERTEX;
  static const OGLAttrib COLOR;
  static const OGLAttrib NORMAL;
  static const OGLAttrib TEX_COORD_0;
  static const OGLAttrib TEX_COORD_1;
  static const OGLAttrib TANGENT;
  static const OGLAttrib BINORMAL;

  // fragment data names and locations, defined in internals.cpp
  static const OGLFragData FRAG_COLOR;

  // uniform block names and indices, defined in internals.cpp
  static const OGLUniformBlock LIGHT;
  static const OGLUniformBlock MATERIAL;

  // uniform names
  static const char* MODEL_VIEW_MATRIX;
  static const char* PROJECTION_MATRIX;
  static const char* MVP_MATRIX;
  static const char* NORMAL_MATRIX;
  static const char* TEXTURE_MATRIX;
  static const char* COLOR_MATRIX;
  static const char* N_LIGHTS;
  static const char* GLOBAL_AMBIENT_LIGHT;
  static const char* TIME;

  // sampler names and texture units
  static const OGLSampler TEXTURE0;
  static const OGLSampler TEXTURE1;

  // parameters
  static const int MAX_NUMBER_OF_LIGHTS = 10;

};

} /* namespace scg */


#endif /* SCG_INTERNALS_H_ */