NAP
Public Member Functions | List of all members
SkyBoxShader Class Reference

#include <skyboxshader.h>

Public Member Functions

 SkyBoxShader (Core &core)
 
virtual bool init (utility::ErrorState &errorState) override
 
- Public Member Functions inherited from Shader
 Shader (Core &core)
 
 ~Shader ()
 
const VertexAttributeDeclarationsgetAttributes () const
 
VkShaderModule getVertexModule () const
 
VkShaderModule getFragmentModule () const
 
- Public Member Functions inherited from BaseShader
 BaseShader (Core &core)
 
virtual ~BaseShader ()
 
const SamplerDeclarationsgetSamplerDeclarations () const
 
const std::vector< BufferObjectDeclaration > & getUBODeclarations () const
 
const std::vector< BufferObjectDeclaration > & getSSBODeclarations () const
 
const ShaderConstantDeclarationsgetConstantDeclarations () const
 
const std::string & getDisplayName () const
 
VkDescriptorSetLayout getDescriptorSetLayout () const
 
void clear ()
 
- Public Member Functions inherited from Resource
 Resource ()
 
- Public Member Functions inherited from Object
 Object ()
 
virtual ~Object ()
 
virtual void onDestroy ()
 
 Object (Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&)=delete
 
Objectoperator= (Object &&)=delete
 

Additional Inherited Members

- Public Types inherited from Shader
enum  EShaderType : uint { Vertex = 0x01, Fragment = 0x02 }
 
using ShaderTypeFlags = uint
 
- Static Public Member Functions inherited from Object
static bool isIDProperty (rtti::Instance &object, const rtti::Property &property)
 
- Public Attributes inherited from Object
std::string mID
 Property: 'mID' unique name of the object. Used as an identifier by the system. More...
 
- Protected Member Functions inherited from Shader
bool load (const std::string &displayName, const std::vector< std::string > &searchPaths, const char *vertShader, int vertSize, const char *fragShader, int fragSize, utility::ErrorState &errorState)
 
bool loadDefault (const std::string &displayName, utility::ErrorState &errorState)
 
- Protected Member Functions inherited from BaseShader
bool initLayout (VkDevice device, nap::utility::ErrorState &errorState)
 
bool verifyShaderVariableDeclarations (utility::ErrorState &errorState)
 
- Protected Attributes inherited from BaseShader
RenderServicemRenderService = nullptr
 Handle to render engine. More...
 
std::string mDisplayName
 Filename of shader used as display name. More...
 
BufferObjectDeclarationList mUBODeclarations
 All uniform buffer object declarations. More...
 
BufferObjectDeclarationList mSSBODeclarations
 All storage buffer object declarations. More...
 
SamplerDeclarations mSamplerDeclarations
 All sampler declarations. More...
 
ShaderConstantDeclarations mConstantDeclarations
 All shader constant declarations. More...
 
VkDescriptorSetLayout mDescriptorSetLayout = VK_NULL_HANDLE
 Descriptor set layout. More...
 

Description

SkyBox Shader

Renders a skybox from a cube texture. Negates the translational component of the view matrix to fake unlimited depth. Should render a nap::BoxMesh as the first object to fill the background. The shader variables are set automatically using the helper component nap::RenderSkyBoxComponent.

The skybox shader exposes the following shader variables for users:

samplerCube cubeTexture;
Inheritance diagram for SkyBoxShader:
[legend]
Collaboration diagram for SkyBoxShader:
[legend]

Constructor & Destructor Documentation

◆ SkyBoxShader()

SkyBoxShader ( Core core)

Member Function Documentation

◆ init()

virtual bool init ( utility::ErrorState errorState)
overridevirtual

Cross compiles the constant GLSL shader code to SPIR-V, creates the shader module and parses all the uniforms and samplers.

Parameters
errorStatecontains the error if initialization fails.
Returns
if initialization succeeded.

Reimplemented from Object.