#include <gl.h>

Inheritance diagram for scl::gl:

Public Member Functions
const vec4 &	GetClearColor () const override

bool	GetWireframeMode () const override

render_cull_face_mode	GetCullingMode () const override

bool	GetVSync () const override

void	SetClearColor (const vec4 &ClearColor) override

void	SetWireframeMode (bool IsWireframe) override

void	SetCullingMode (render_cull_face_mode CullingMode) override

void	SetVSync (bool VSync)

void	CreateContext (const HWND &hAppWnd, int W, int H, bool VSync)

void	Init () override

void	Close () override

void	SwapBuffers () override

void	DrawIndices (const shared< vertex_array > &VertexArray) override

void	DrawIndicesInstanced (const shared< vertex_array > &VertexArray, int InstanceCount) override

shared< shader_program >	GetSingleColorMaterialShader () const override

shared< shader_program >	GetPhongGeometryShader () const override

shared< shader_program >	GetPhongLightingShader () const override

shared< shader_program >	GetShadowPassShader () const override

shared< shader_program >	GetToneMappingPassShader () const override

shared< shader_program >	GetGaussianBlurPassShader () const override

shared< shader_program >	GetTextureAddPassShader () const override

Public Member Functions inherited from scl::render_context
virtual const vec4 &	GetClearColor () const =0

virtual bool	GetWireframeMode () const =0

virtual render_cull_face_mode	GetCullingMode () const =0

virtual bool	GetVSync () const =0

virtual void	SetClearColor (const vec4 &ClearColor)=0

virtual void	SetWireframeMode (bool IsWireframe)=0

virtual void	SetCullingMode (render_cull_face_mode CullingMode)=0

virtual void	SetVSync (bool VSync)=0

	render_context ()

virtual	~render_context ()

virtual void	Init ()=0

virtual void	Close ()=0

virtual void	SwapBuffers ()=0

virtual void	DrawIndices (const shared< vertex_array > &Mesh)=0

virtual void	DrawIndicesInstanced (const shared< vertex_array > &Mesh, int InstanceCount)=0

virtual shared< shader_program >	GetSingleColorMaterialShader () const =0

virtual shared< shader_program >	GetPhongGeometryShader () const =0

virtual shared< shader_program >	GetPhongLightingShader () const =0

virtual shared< shader_program >	GetShadowPassShader () const =0

virtual shared< shader_program >	GetToneMappingPassShader () const =0

virtual shared< shader_program >	GetGaussianBlurPassShader () const =0

virtual shared< shader_program >	GetTextureAddPassShader () const =0

Static Public Member Functions
static GLenum	GetGLPrimitiveType (mesh_type MeshType)

static GLenum	GetGLShaderVariableType (shader_variable_type Type)

Static Public Member Functions inherited from scl::render_context
static render_context_api	GetApi ()

static u32	GetShaderVariableTypeSize (shader_variable_type Type)

static u32	GetShaderVariableComponentsCount (shader_variable_type Type)

static unique< render_context >	Create ()

Additional Inherited Members
Static Public Attributes inherited from scl::render_context
static const int	BINDING_POINT_SCENE_DATA = 0

static const int	BINDING_POINT_MATERIAL_DATA = 5

static const int	BINDING_POINT_LIGHTS_STORAGE = 10

static const int	BINDING_POINT_SHADOW_CASTERS_STORAGE = 11

static const int	BINDING_POINT_FREE = 20

static const int	TEXTURE_SLOT_MATERIAL_DIFFUSE = 0

static const int	TEXTURE_SLOT_MATERIAL_SPECULAR = 1

static const int	TEXTURE_SLOT_MATERIAL_EMISSION_MAP = 2

static const int	TEXTURE_SLOT_MATERIAL_NORMAL_MAP = 3

static const int	TEXTURE_SLOT_SHADOW_MAP = 5

static const int	TEXTURE_SLOT_HDR_BUFFER = 6

static const int	TEXTURE_SLOT_BLUR_BUFFER = 7

static const int	TEXTURE_SLOT_APPLY_SOURCE = 9

static const int	TEXTURE_SLOT_APPLY_TEXTURE_ADD = 10

static const int	TEXTURE_SLOT_GEOM_PASS_OUT_POSITION = 11

static const int	TEXTURE_SLOT_GEOM_PASS_OUT_NORMAL = 12

static const int	TEXTURE_SLOT_GEOM_PASS_OUT_COLOR = 13

static const int	TEXTURE_SLOT_GEOM_PASS_OUT_PHONG_DIFFUSE = 14

static const int	TEXTURE_SLOT_GEOM_PASS_OUT_PHONG_SPECULAR = 15

static const int	TEXTURE_SLOT_GEOM_PASS_OUT_PHONG_SHININESS = 16

static const int	TEXTURE_SLOT_LIGHTING_PASS_OUT_COLOR = 17

static const int	TEXTURE_SLOT_LIGHTING_PASS_OUT_BRIGHT_COLOR = 18

static const int	LIGHTS_MAX_POINT = 50

static const int	LIGHTS_MAX_SPOT = 50

static const int	COLOR_ATTACHMENT_GEOM_PASS_OUT_POSITION = 0

static const int	COLOR_ATTACHMENT_GEOM_PASS_OUT_NORMAL = 1

static const int	COLOR_ATTACHMENT_GEOM_PASS_OUT_COLOR = 2

static const int	COLOR_ATTACHMENT_GEOM_PASS_OUT_PHONG_DIFFUSE = 3

static const int	COLOR_ATTACHMENT_GEOM_PASS_OUT_PHONG_SPECULAR = 4

static const int	COLOR_ATTACHMENT_GEOM_PASS_OUT_PHONG_SHININESS = 5

static const int	COLOR_ATTACHMENT_LIGHTING_PASS_OUT_COLOR = 0

static const int	COLOR_ATTACHMENT_LIGHTING_PASS_OUT_BRIGHT_COLOR = 1

static const int	MESH_RESTART_INDEX = -1

Detailed Description

OpenGL context

Definition at line 22 of file gl.h.

Member Function Documentation

◆ Close()

void scl::gl::Close ( )

overridevirtual

Render context deinitialisation function.

Parameters

None.

Returns: None.

Implements scl::render_context.

Definition at line 219 of file gl.cpp.

{
    wglMakeCurrent(nullptr, nullptr);
    wglDeleteContext(hGLRC);
    ReleaseDC(*hWnd, hDC);
}

◆ CreateContext()

void scl::gl::CreateContext	(	const HWND &	hAppWnd,
		int	W,
		int	H,
		bool	VSync
	)

OpenGL context methods.

Render system type constructor.

Parameters

hAppWnd	- window handle.
W,H	- window size.
VSync	- vertical syncronisation enable flag.

Returns: None.

!SCL_PLATFORM_WINDOWS

Definition at line 178 of file gl.cpp.

{
#ifdef SCL_PLATFORM_WINDOWS
    hWnd = &hAppWnd;
    hDC = GetDC(hAppWnd);
    hGLRC = glInitialiseContext(hDC);
#endif 
    SetVSync(VSync);
 
    // Set default OpenGL parameters
    glClearColor(0, 0, 0, 0);
    glEnable(GL_DEPTH_TEST);
    glEnable(GL_BLEND);
 
    glEnable(GL_PRIMITIVE_RESTART);
    glPrimitiveRestartIndex(render_context::MESH_RESTART_INDEX);
 
    // Enable debug callback
#ifndef SCL_DIST
    glEnable(GL_DEBUG_OUTPUT);
    glEnable(GL_DEBUG_OUTPUT_SYNCHRONOUS);
    glDebugMessageCallback(glDebugOutput, nullptr);
    glDebugMessageControl(GL_DONT_CARE, GL_DONT_CARE, GL_DONT_CARE, 0, nullptr, GL_TRUE);
#endif
}

◆ DrawIndices()

void scl::gl::DrawIndices ( const shared< vertex_array > & VertexArray )

overridevirtual

Draw vertices function.

Parameters

VertexArray - mesh, containing vertices and vertex indices to draw.

Returns: None.

Implements scl::render_context.

Definition at line 234 of file gl.cpp.

{
    VertexArray->Bind();
    glDrawElements(
        GetGLPrimitiveType(VertexArray->GetType()),
        VertexArray->GetIndexBuffer()->GetCount(),
        GL_UNSIGNED_INT,
        nullptr
    );
    VertexArray->Unbind();
}

◆ DrawIndicesInstanced()

void scl::gl::DrawIndicesInstanced	(	const shared< vertex_array > &	VertexArray,
		int	InstanceCount
	)

overridevirtual

Draw vertices instanced function.

Parameters

VertexArray - mesh, containing vertices and vertex indices to draw.

Returns: None.

Implements scl::render_context.

Definition at line 246 of file gl.cpp.

{
    VertexArray->Bind();
    glDrawElementsInstanced(
        GetGLPrimitiveType(VertexArray->GetType()),
        VertexArray->GetIndexBuffer()->GetCount(),
        GL_UNSIGNED_INT,
        nullptr,
        InstanceCount
    );
    VertexArray->Unbind();
}

◆ GetClearColor()

const scl::vec4 & scl::gl::GetClearColor ( ) const

overridevirtual

!SCL_PLATFORM_WINDOWS

OpenGL data getter/setter functions.

Frame clear color setter function.

!SCL_PLATFORM_WINDOWS

Implements scl::render_context.

Definition at line 82 of file gl.cpp.

{
    return ClearColor;
}

◆ GetCullingMode()

scl::render_cull_face_mode scl::gl::GetCullingMode ( ) const

overridevirtual

Render culling mode setter function.

Implements scl::render_context.

Definition at line 92 of file gl.cpp.

{
    return CullingMode;
}

◆ GetGaussianBlurPassShader()

scl::shared< scl::shader_program > scl::gl::GetGaussianBlurPassShader ( ) const

overridevirtual

OpenGL specific gaussian blur pass shader getter function.

Implements scl::render_context.

Definition at line 59 of file gl_built_in_objects.cpp.

{
    if (gaussian_blur_pass_shader == nullptr)
        gaussian_blur_pass_shader = assets_manager::LoadShader("assets/shaders/lib/gaussian_blur_pass.glsl");
    return gaussian_blur_pass_shader;
}

◆ GetGLPrimitiveType()

GLenum scl::gl::GetGLPrimitiveType ( mesh_type MeshType )

static

Get OpenGL primitive type by mesh type function.

Parameters

MeshType - mesh type to get OpenGL primitive type according to.

Returns: OpenGL primitive type.

Definition at line 135 of file gl.cpp.

{
    switch (MeshType)
    {
    case scl::mesh_type::LINES:        return GL_LINES;
    case scl::mesh_type::POINTS:       return GL_POINTS;
    case scl::mesh_type::PATCHES:      return GL_PATCHES;
    case scl::mesh_type::TRIANGLES:    return GL_TRIANGLES;
    case scl::mesh_type::TRISTRIP:     return GL_TRIANGLE_STRIP;
    }
 
    SCL_CORE_ASSERT(0, "Unknown mesh type!");
    return GLenum();
}

◆ GetGLShaderVariableType()

GLenum scl::gl::GetGLShaderVariableType ( shader_variable_type Type )

static

Get OpenGL shader variable type function.

Parameters

Type	- top-level api shader variable.

Returns: OpenGL shader variable type.

Definition at line 150 of file gl.cpp.

{
    switch (Type)
    {
    case scl::shader_variable_type::BOOL:
        return GL_BOOL;
 
    case scl::shader_variable_type::INT:
    case scl::shader_variable_type::INT2:
    case scl::shader_variable_type::INT3:
    case scl::shader_variable_type::INT4:
        return GL_INT;
 
    case scl::shader_variable_type::FLOAT:
    case scl::shader_variable_type::FLOAT2:
    case scl::shader_variable_type::FLOAT3:
    case scl::shader_variable_type::FLOAT4:
    case scl::shader_variable_type::MATR4:
        return GL_FLOAT;
    }
 
    SCL_CORE_ASSERT(0, "Unknown shader veriable type.");
    return GLenum();
}

◆ GetPhongGeometryShader()

scl::shared< scl::shader_program > scl::gl::GetPhongGeometryShader ( ) const

overridevirtual

OpenGL specific phong lighint model shader for geometry pass getter function.

Implements scl::render_context.

Definition at line 31 of file gl_built_in_objects.cpp.

{
    if (phong_geometry_shader == nullptr)
        phong_geometry_shader = assets_manager::LoadShader("assets/shaders/lib/phong_geometry_pass.glsl");
    return phong_geometry_shader;
}

◆ GetPhongLightingShader()

scl::shared< scl::shader_program > scl::gl::GetPhongLightingShader ( ) const

overridevirtual

OpenGL specific phong lighint model shader for lighting pass getter function.

Implements scl::render_context.

Definition at line 38 of file gl_built_in_objects.cpp.

{
    if (phong_lighting_shader == nullptr)
        phong_lighting_shader = assets_manager::LoadShader("assets/shaders/lib/phong_lighting_pass.glsl");
    return phong_lighting_shader;
}

◆ GetShadowPassShader()

scl::shared< scl::shader_program > scl::gl::GetShadowPassShader ( ) const

overridevirtual

OpenGL specific shadow pass shader getter function.

Implements scl::render_context.

Definition at line 45 of file gl_built_in_objects.cpp.

{
    if (shadow_pass_shader == nullptr)
        shadow_pass_shader = assets_manager::LoadShader("assets/shaders/lib/shadow_pass.glsl");
    return shadow_pass_shader;
}

◆ GetSingleColorMaterialShader()

scl::shared< scl::shader_program > scl::gl::GetSingleColorMaterialShader ( ) const

overridevirtual

Sculpto library built-in backend API specific rendering objects getter function.

OpenGL specific single color material shader getter function.

Implements scl::render_context.

Definition at line 24 of file gl_built_in_objects.cpp.

{
    if (single_color_material_shader == nullptr)
        single_color_material_shader = assets_manager::LoadShader("assets/shaders/lib/single_color_geometry.glsl");
    return single_color_material_shader;
}

◆ GetTextureAddPassShader()

scl::shared< scl::shader_program > scl::gl::GetTextureAddPassShader ( ) const

overridevirtual

OpenGL specific gaussian blur pass shader getter function.

Implements scl::render_context.

Definition at line 66 of file gl_built_in_objects.cpp.

{
    if (texture_add_pass_shader == nullptr)
        texture_add_pass_shader = assets_manager::LoadShader("assets/shaders/lib/texture_add.glsl");
    return texture_add_pass_shader;
}

◆ GetToneMappingPassShader()

scl::shared< scl::shader_program > scl::gl::GetToneMappingPassShader ( ) const

overridevirtual

OpenGL specific full viewport mesh with tone mapping shader.

Implements scl::render_context.

Definition at line 52 of file gl_built_in_objects.cpp.

{
    if (tone_mapping_pass_shader == nullptr)
        tone_mapping_pass_shader = assets_manager::LoadShader("assets/shaders/lib/tone_mapping_pass.glsl");
    return tone_mapping_pass_shader;
}

◆ GetVSync()

bool scl::gl::GetVSync ( ) const

overridevirtual

Render virtual syncronisation flag getter function.

Implements scl::render_context.

Definition at line 97 of file gl.cpp.

{
    return IsVSync;
}

◆ GetWireframeMode()

bool scl::gl::GetWireframeMode ( ) const

overridevirtual

Render wire frame mode setter function.

Implements scl::render_context.

Definition at line 87 of file gl.cpp.

{
    return IsWireframe;
}

◆ Init()

void scl::gl::Init ( )

overridevirtual

Render context initialisation function.

Parameters

None.

Returns: None.

!SCL_PLATFORM_WINDOWS

Implements scl::render_context.

Definition at line 205 of file gl.cpp.

{
    SCL_CORE_SUCCES("OpenGL render context initialisation started.");
 
#ifdef SCL_PLATFORM_WINDOWS
    application &app = application::Get();
    const window &win = app.GetWindow();
    const window::data win_data = win.GetWindowData();
 
    this->CreateContext(win.GetHandle(), win_data.Width, win_data.Height, true);
    SCL_CORE_SUCCES("Windows OpenGL render context initialised successfully.");
#endif 
}

◆ SetClearColor()

void scl::gl::SetClearColor ( const vec4 & ClearColor )

overridevirtual

Frame clear color setter function.

Implements scl::render_context.

Definition at line 102 of file gl.cpp.

{
    this->ClearColor = ClearColor;
    glClearColor(SCL_VEC_XYZW(ClearColor));
}

◆ SetCullingMode()

void scl::gl::SetCullingMode ( render_cull_face_mode CullingMode )

overridevirtual

Render culling mode setter function.

Implements scl::render_context.

Definition at line 114 of file gl.cpp.

{
    this->CullingMode = CullingMode;
    switch (CullingMode)
    {
    case scl::render_cull_face_mode::OFF:   glDisable(GL_CULL_FACE); return;
    case scl::render_cull_face_mode::BACK:  glEnable(GL_CULL_FACE); glCullFace(GL_BACK); return;
    case scl::render_cull_face_mode::FRONT: glEnable(GL_CULL_FACE); glCullFace(GL_FRONT); return;
    }
 
    SCL_CORE_ASSERT(0, "Unknown culling mode!");
}

◆ SetVSync()

void scl::gl::SetVSync ( bool VSync )

virtual

Render virtual syncronisation flag setter function.

SCL_PLATFORM_WINDOWS

Implements scl::render_context.

Definition at line 127 of file gl.cpp.

{
    this->IsVSync = IsVSync;
#ifdef SCL_PLATFORM_WINDOWS
    wglSwapIntervalEXT(IsVSync);
#endif 
}

◆ SetWireframeMode()

void scl::gl::SetWireframeMode ( bool IsWireframe )

overridevirtual

Render wire frame mode setter function.

Implements scl::render_context.

Definition at line 108 of file gl.cpp.

{
    this->IsWireframe = IsWireframe;
    glPolygonMode(GL_FRONT_AND_BACK, IsWireframe ? GL_LINE : GL_FILL);
}

◆ SwapBuffers()

void scl::gl::SwapBuffers ( )

overridevirtual

Swap frame buffers function.

Parameters

None.

Returns: None.

Another way (not sure): wglSwapLayerBuffers(hDC, WGL_SWAP_MAIN_PLANE);

Implements scl::render_context.

Definition at line 226 of file gl.cpp.

{
    ::SwapBuffers(hDC);
}

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

platform/opengl/gl.h
platform/opengl/gl.cpp
platform/opengl/gl_built_in_objects.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Close()

◆ CreateContext()

◆ DrawIndices()

◆ DrawIndicesInstanced()

◆ GetClearColor()

◆ GetCullingMode()

◆ GetGaussianBlurPassShader()

◆ GetGLPrimitiveType()

◆ GetGLShaderVariableType()

◆ GetPhongGeometryShader()

◆ GetPhongLightingShader()

◆ GetShadowPassShader()

◆ GetSingleColorMaterialShader()

◆ GetTextureAddPassShader()

◆ GetToneMappingPassShader()

◆ GetVSync()

◆ GetWireframeMode()

◆ Init()

◆ SetClearColor()

◆ SetCullingMode()

◆ SetVSync()

◆ SetWireframeMode()

◆ SwapBuffers()