gcmgl

gcmgl is a C++ graphics library targeting PlayStation 3 (GCM) and Linux (x86_64, OpenGL). gcmgl provides a platform-abstracted renderer interface covering viewports, buffers, shader programs, textures, blend states, draw calls, and batch rendering. Mathematics support is provided by mathsfury.

• mathsfury

• ps3toolchain
• PSL1GHT
• NVIDIA Cg Toolkit
• ImageMagick
• OffsetAllocator

• glad
• SIMDe (optional, for SSE path)
• Slang

• BufferHandle
• ShaderProgramHandle
• TextureHandle
• SamplerHandle
• RenderTargetHandle
• UniformBlockLayoutHandle

• void* m_pWindow
• uint32 m_Width
• uint32 m_Height
• bool m_IsFullscreen
• bool m_IsVSync

• ClearNone
• ClearColor
• ClearDepth
• ClearStencil
• ClearAll

• float32 m_X
• float32 m_Y
• float32 m_Width
• float32 m_Height
• float32 m_MinDepth
• float32 m_MaxDepth

• int32 m_X
• int32 m_Y
• uint32 m_Width
• uint32 m_Height

• Static
• Dynamic
• Immutable

• UInt16
• UInt32

• R8
• RG8
• RGB8
• RGBA8
• R16F
• RG16F
• RGB16F
• RGBA16F
• R32F
• RG32F
• RGB32F
• RGBA32F
• Depth16
• Depth24
• Depth32F
• Depth24Stencil8

• Repeat
• MirroredRepeat
• ClampToEdge

• None
• RefToTexture

• ShaderStageVertex
• ShaderStageFragment
• ShaderStageAll

• Unspecified
• Float
• Float2
• Float3
• Float4
• UByte4_Norm

• Unspecified
• Position
• Weight
• Normal
• Color0
• Color1
• Fog
• PointSize
• EdgeFlag
• TexCoord0
• TexCoord1
• TexCoord2
• TexCoord3
• TexCoord4
• TexCoord5
• TexCoord6
• Tangent
• TexCoord7
• Binormal

• CFixedString m_Name
• VertexFormat_t::Enum m_Format
• uint32 m_Offset
• uint32 m_Location
• VertexSemantic_t::Enum m_VertexSemantic

• void AddAttribute(const CFixedString& name, uint32 format, uint32 offset, uint32 location = 0)
• void AddAttribute(const CFixedString& name, uint32 format, uint32 offset, VertexSemantic_t::Enum vertexSemantic, uint32 location = 0)
• void SetStride(uint32 vertexStride)
• uint32 GetStride() const
• const CUtlVector<VertexAttribute_t>& GetAttributes() const

• bool m_IsEnabled
• bool m_IsAdditive

• bool m_IsDepthTest
• bool m_IsDepthWrite

• uint64 m_IndexOffset
• const CVertexLayout* m_pVertexLayout
• ShaderProgramHandle m_hShaderProgram
• BufferHandle m_hVertexBuffer
• BufferHandle m_hIndexBuffer
• uint32 m_VertexStride
• uint32 m_VertexOffset
• DepthStencilState_t m_DepthStencilState
• BlendState_t m_BlendState

• CUtlVector<CFixedString> m_UniformNames
• uint32 m_Binding
• uint32 m_Size

• CQuaternion m_Rotation
• CVector3 m_Position
• CVector3 m_Scale
• CMatrix4 ToMatrix() const

• CUtlVector<BatchChunkTransform_t> m_BatchChunkTransforms
• CVector3 m_Center
• CVector3 m_Extent

• CUtlVector<BatchChunk_t> m_BatchChunks
• const CVector3* m_pCameraPos
• void Add(const CVector3& position, const CQuaternion& rotation = CQuaternion(), const CVector3& scale = CVector3(1.0f, 1.0f, 1.0f))
• void Build(float32 chunkSize = 500.0f)
• void Clear()
• uint32 GetCount() const

• CVector3 m_Normal
• float32 m_Distance

• Outside
• Partial
• Inside

• bool Init(const RendererDesc_t& rendererDesc)
• void Shutdown()
• void SetEnvironment()
• void BeginFrame()
• void EndFrame()
• void Clear(uint32 clearFlags, const CColor& color = CColor::Black, float32 depth = 1.0f, uint32 stencil = 0)
• void GetFramebufferSize(uint32& width, uint32& height) const
• float32 GetAspectRatio() const
• void SetFullViewport()
• void SetViewport(const Viewport_t& viewport)
• Viewport_t GetViewport()
• void SetScissor(const Rect_t& rect)
• void SetStencilRef(uint32 stencilRef)
• RenderTargetHandle CreateRenderTarget(uint32 width, uint32 height, TextureFormat_t::Enum colorFormat, TextureFormat_t::Enum depthFormat)
• RenderTargetHandle CreateRenderTargetCube(uint32 size, TextureFormat_t::Enum colorFormat, TextureFormat_t::Enum depthFormat)
• void DestroyRenderTarget(RenderTargetHandle hRenderTarget)
• void SetRenderTarget(RenderTargetHandle hRenderTarget, uint32 faceIndex = 0)
• TextureHandle GetRenderTargetColorTexture(RenderTargetHandle hRenderTarget) const
• TextureHandle GetRenderTargetDepthTexture(RenderTargetHandle hRenderTarget) const
• BufferHandle CreateVertexBuffer(const void* pData, uint64 size, BufferUsage_t::Enum usage)
• BufferHandle CreateIndexBuffer(const void* pData, uint64 size, IndexFormat_t::Enum format, BufferUsage_t::Enum usage)
• BufferHandle CreateConstantBuffer(uint64 size, BufferUsage_t::Enum usage)
• void UpdateBuffer(BufferHandle hBuffer, const void* pData, uint64 size, uint64 offset = 0)
• void DestroyBuffer(BufferHandle hBuffer)
• void* MapBuffer(BufferHandle hBuffer)
• void UnmapBuffer(BufferHandle hBuffer)
• BufferHandle CreateStagingBuffer(uint64 size)
• ShaderProgramHandle CreateShaderProgram(const CFixedString& shaderName)
• ShaderProgramHandle GetOrCreateShaderProgram(const CFixedString& shaderName)
• void DestroyShaderProgram(ShaderProgramHandle hProgram)
• void ClearShaderCache()
• TextureHandle CreateTexture2D(uint32 width, uint32 height, TextureFormat_t::Enum format, const void* pData = GCMGL_NULL)
• TextureHandle CreateTextureCube(uint32 size, TextureFormat_t::Enum format, const void** ppFaces = GCMGL_NULL)
• void SetTexture(TextureHandle hTexture, uint32 slot, ShaderStage_t stage, TextureWrapMode_t::Enum wrapMode = TextureWrapMode_t::Repeat)
• void SetTextureCompareMode(TextureHandle hTexture, TextureCompareMode_t::Enum compareMode)
• void SetSampler(SamplerHandle hSampler, uint32 slot, ShaderStage_t stage)
• void UpdateTexture(TextureHandle hTexture, const void* pData, uint32 mipLevel = 0)
• void DestroyTexture(TextureHandle hTexture)
• void SetShaderProgram(ShaderProgramHandle hProgram)
• void SetVertexBuffer(BufferHandle hBuffer, uint32 slot = 0, uint32 vertexStride = 0, uint32 offset = 0, const CVertexLayout* pLayout = GCMGL_NULL)
• void SetIndexBuffer(BufferHandle hBuffer, uint64 offset = 0)
• UniformBlockLayoutHandle CreateUniformBlockLayout(const UniformBlockLayout_t& layout)
• UniformBlockLayoutHandle GetOrCreateUniformBlockLayout(ShaderProgramHandle hProgram, const UniformBlockLayout_t& layout)
• void SetConstantBuffer(BufferHandle hBuffer, UniformBlockLayoutHandle hLayout, uint32 slot, ShaderStage_t stage)
• int32 GetUniformBlockBinding(ShaderProgramHandle hProgram, const char* pBlockName)
• void SetBlendState(const BlendState_t& state)
• void SetDepthStencilState(const DepthStencilState_t& state)
• void ExtractFrustumPlanes(const CMatrix4& mvp, Plane_t* pPlanes)
• bool TestAABBFrustum(const CVector3& center, const CVector3& extent, const Plane_t* pPlanes)
• void Draw(uint32 vertexCount, uint32 startVertex = 0, const CMatrix4* pViewProjection = GCMGL_NULL, const CVector3* pAABBCenter = GCMGL_NULL, const CVector3* pAABBExtent = GCMGL_NULL)
• void DrawIndexed(uint32 indexCount, uint32 startIndex = 0, int32 baseVertex = 0, const CMatrix4* pViewProjection = GCMGL_NULL, const CVector3* pAABBCenter = GCMGL_NULL, const CVector3* pAABBExtent = GCMGL_NULL)
• void DrawBatched(uint32 vertexCount, const CBatch& batch, const CMatrix4& viewProjection, uint32 startVertex = 0)
• void DrawIndexedBatched(uint32 indexCount, uint32 vertexCount, const CBatch& batch, const CMatrix4& viewProjection, uint32 startIndex = 0, int32 baseVertex = 0, bool isPerInstanceCull = true)
• void DrawInstanced(uint32 vertexCount, uint32 instanceCount, const CMatrix4* pMatrices, const CVertexLayout* pInstanceLayout = GCMGL_NULL)
• void DrawIndexedInstanced(uint32 indexCount, uint32 instanceCount, const CMatrix4* pMatrices, uint32 startIndex = 0, const CVertexLayout* pInstanceLayout = GCMGL_NULL)
• void SetPipelineState(const PipelineState_t& state)
• void FlushPipelineState()

• float32 GetAspectRatio() const
• FrustumVisibility_t::Enum GetAABBFrustumVisibility(const CVector3& center, const CVector3& extent, const Plane_t* pPlanes)

Install required build dependencies:

• Fedora:

sudo dnf install cmake gcc-c++ glfw-devel mesa-libGL-devel pkgconf-pkg-config ImageMagick

Build using the provided scripts:

• Linux (x86_64):

./scripts/build_linux_x86_64.sh

• PlayStation 3:

./scripts/build_ps3.sh

Build scripts prompt for an example to build: Triangle, Cube, Shader, Textured, Lit, TexturedLit, Batch, or BatchInstanced.

• Triangle
• Cube
• Shader
• Textured
• Lit
• TexturedLit
• Batch
• BatchInstanced

gcmgl is licensed under the MIT License.