Kataglyphis-Renderer documentation

Welcome to the documentation for Kataglyphis-Renderer (BeschleunigerBallett).

• High-performance rendering engine

• Modern C++ architecture

• Extensive API documentation

Overview (README)

Get started and view the main project overview.

Kataglyphis Renderer

API Reference

Explore the complete C++ API documentation.

Library API

Graphviz Architecture

View architecture diagrams and module boundaries.

Graphviz Include Graphs

Contents:

• Kataglyphis Renderer
• Shaders
• Tests
• Format cmake files
• Format code files
• Docs
• Library API
  • Namespace @105
  • Namespace @107
  • Namespace @32
  • Namespace @51
  • Namespace @57
  • Namespace @62
  • Namespace @66
  • Namespace @8
  • Namespace Kataglyphis
  • Namespace Kataglyphis::debug
  • Namespace Kataglyphis::Frontend
  • Namespace Kataglyphis::Frontend::@6
  • Namespace Kataglyphis::OpenGLApp
  • Namespace Kataglyphis::ShaderIncludes
  • Namespace Kataglyphis::Vulkan
  • Namespace Kataglyphis::VulkanRendererInternals
  • Namespace Kataglyphis::VulkanRendererInternals::FrontendShared
  • Namespace Kataglyphis::VulkanRendererInternals::PipelineUtils
  • Namespace vertex
  • Struct GlobalUBO
  • Struct VulkanDevice::DeviceFeatureConfig
  • Struct VulkanRenderer::AcquireResult
  • Struct VulkanRenderer::FrameSyncResult
  • Struct BlasInput
  • Struct BottomLevelAccelerationStructure
  • Struct BuildAccelerationStructure
  • Struct GUIRendererSharedVars
  • Struct PathTracing::SpecializationData
  • Struct QueueFamilyIndices
  • Struct SwapChainDetails
  • Struct TopLevelAccelerationStructure
  • Struct ObjectDescription
  • Struct PushConstantPathTracing
  • Struct PushConstantPost
  • Struct PushConstantRasterizer
  • Struct PushConstantRaytracing
  • Struct SceneUBO
  • Struct ViewFrustumCulling::frustum_plane
  • Class AABB
  • Class CascadedShadowMap
  • Class ClampToEdgeMode
  • Class Clouds
  • Class ComputeShaderProgram
  • Class DebugApp
  • Class DirectionalLight
  • Class DirectionalShadowMapPass
  • Class GameObject
  • Class GBuffer
  • Class GeometryPass
  • Class GeometryPassShaderProgram
  • Class GUI
  • Class Allocator
  • Class App
  • Class GUI
  • Class Window
  • Class Mesh
  • Class Model
  • Class ObjLoader
  • Class Scene
  • Class ShaderHelper
  • Class Texture
  • Class VulkanBuffer
  • Class VulkanBufferManager
  • Class VulkanDevice
  • Class VulkanImage
  • Class VulkanImageView
  • Class VulkanInstance
  • Class VulkanRenderer
  • Class ASManager
  • Class CommandBufferManager
  • Class PathTracing
  • Class PostStage
  • Class Rasterizer
  • Class Raytracing
  • Class VulkanSwapChain
  • Class LightingPass
  • Class LightingPassShaderProgram
  • Class LoadingScreen
  • Class Mesh
  • Class MirroredRepeatMode
  • Class Model
  • Class Noise
  • Class OmniDirShadowMap
  • Class OmniDirShadowShaderProgram
  • Class OmniShadowMapPass
  • Class PointLight
  • Class Quad
  • Class RandomNumbers
  • Class Renderer
  • Class RenderPass
  • Class RenderPassSceneDependend
  • Class RepeatMode
  • Class Scene
  • Class ShaderIncludes
  • Class ShaderProgram
  • Class ShadowMap
  • Class SkyBox
  • Class Texture
  • Class TextureWrappingMode
  • Class ViewFrustumCulling
  • Class Window
  • Enum GpuSelectionMode
  • Function BENCHMARK(BM_StringCreation)
  • Function BENCHMARK(BM_StringCopy)
  • Function BENCHMARK_MAIN
  • Function BM_StringCopy
  • Function BM_StringCreation
  • Function FUZZ_TEST
  • Function glDebugOutput
  • Function IntegerAdditionCommutes
  • Function Kataglyphis::align_up
  • Function Kataglyphis::choose_supported_format
  • Function Kataglyphis::debug::debug_utils_messenger_callback
  • Function Kataglyphis::debug::free_debug_callback
  • Function Kataglyphis::debug::setup_debugging
  • Function Kataglyphis::fatal_error
  • Function Kataglyphis::Frontend::on_error_callback
  • Template Function Kataglyphis::load_device_proc
  • Function Kataglyphis::OpenGLApp::run
  • Function Kataglyphis::ShaderIncludes::get_shader_includes
  • Function Kataglyphis::Vulkan::check_result(vk::Result, const std::string&)
  • Function Kataglyphis::Vulkan::check_result(VkResult, const std::string&)
  • Template Function Kataglyphis::Vulkan::check_result_value
  • Function Kataglyphis::VulkanRendererInternals::PipelineUtils::build_shader_dir
  • Function Kataglyphis::VulkanRendererInternals::PipelineUtils::create_pipeline_layout
  • Function Kataglyphis::VulkanRendererInternals::PipelineUtils::destroy_pipeline_and_layout
  • Function Kataglyphis::VulkanRendererInternals::PipelineUtils::load_shader_module
  • Function main
  • Function TEST(RendererTest, BasicSetup)
  • Function TEST(ObjLoaderTest, blob)
  • Function TEST(HelloTestCommit, BasicAssertions)
  • Function TEST(Integration, VulkanEngine)
  • Function TEST(HelloTestCompile, BasicAssertions)
  • Function TEST(HelloTestCompile, blob)
  • Function TEST(MyTestSuite, OnePlustTwoIsTwoPlusOne)
  • Function vertex::get_vertex_input_attribute_desc
  • Variable CLOUDS_MATERIAL_ID
  • Variable G_BUFFER_SIZE
  • Variable Kataglyphis::debug::debug_utils_messenger
  • Variable Kataglyphis::debug::vkCreateDebugUtilsMessengerEXT
  • Variable Kataglyphis::debug::vkDestroyDebugUtilsMessengerEXT
  • Variable Kataglyphis::DefaultClearColor
  • Variable Kataglyphis::DefaultWindowHeight
  • Variable Kataglyphis::DefaultWindowWidth
  • Variable Kataglyphis::ENABLE_VALIDATION_LAYERS
  • Variable Kataglyphis::EnableValidationLayers
  • Variable Kataglyphis::GuiDescriptorPoolSize
  • Variable Kataglyphis::GuiMinImageCount
  • Variable Kataglyphis::MaxFrameDraws
  • Variable Kataglyphis::MaxMaterials
  • Variable Kataglyphis::MaxObjects
  • Variable Kataglyphis::MaxRayRecursionDepth
  • Variable Kataglyphis::MaxSamplerAnisotropy
  • Variable Kataglyphis::MaxTextures
  • Variable MAX_FRAME_DRAWS
  • Variable MAX_MATERIALS
  • Variable MAX_OBJECTS
  • Variable MAX_POINT_LIGHTS
  • Variable MAX_RAY_RECURSION_DEPTH
  • Variable MAX_TEXTURE_COUNT
  • Variable NUM_CASCADES
  • Variable NUM_CELL_POSITIONS
  • Variable NUM_CLOUDS
  • Variable NUM_FRUSTUM_PLANES
  • Variable PI
  • Variable SKYBOX_MATERIAL_ID
  • Define ASSERT_VK
  • Define ASSERT_VULKAN
  • Define D_LIGHT_SHADOW_TEXTURES_SLOT
  • Define GBUFFER_TEXTURES_SLOT
  • Define GLFW_INCLUDE_NONE
  • Define GLFW_INCLUDE_NONE
  • Define GLFW_INCLUDE_NONE
  • Define GLFW_INCLUDE_NONE
  • Define GLFW_INCLUDE_VULKAN
  • Define GLFW_INCLUDE_VULKAN
  • Define GLFW_INCLUDE_VULKAN
  • Define GLM_ENABLE_EXPERIMENTAL
  • Define GLM_FORCE_DEPTH_ZERO_TO_ONE
  • Define GLM_FORCE_DEPTH_ZERO_TO_ONE
  • Define GLM_FORCE_RADIANS
  • Define GLM_FORCE_RADIANS
  • Define GLOBAL_UBO_BINDING
  • Define MAX_RESOLUTION_X
  • Define MAX_RESOLUTION_Y
  • Define MODEL_TEXTURES_SLOT
  • Define NOISE_128D_IMAGE_SLOT
  • Define NOISE_128D_TEXTURES_SLOT
  • Define NOISE_32D_IMAGE_SLOT
  • Define NOISE_32D_TEXTURES_SLOT
  • Define NOISE_CELL_POSITIONS_SLOT
  • Define NOT_YET_IMPLEMENTED
  • Define NUM_MIN_CASCADES
  • Define OBJECT_DESCRIPTION_BINDING
  • Define OPENGL_VERSION_MAJOR
  • Define OPENGL_VERSION_MINOR
  • Define OpenGLRenderer_VERSION_MAJOR
  • Define OpenGLRenderer_VERSION_MINOR
  • Define OUT_IMAGE_BINDING
  • Define P_LIGHT_SHADOW_TEXTURES_SLOT
  • Define PI_DEF
  • Define RANDOM_NUMBERS_SLOT
  • Define SAMPLER_BINDING
  • Define SCENE_UBO_BINDING
  • Define SKYBOX_TEXTURES_SLOT
  • Define STORAGE_BUFFER_MATERIAL_ID_BINDING
  • Define TEXTURES_BINDING
  • Define TLAS_BINDING
  • Define UNIFORM_LIGHT_MATRICES_BINDING
  • Define VMA_IMPLEMENTATION
  • Define VULKAN_API_VERSION
  • Typedef Kataglyphis::Expected
  • Typedef Kataglyphis::Unexpected
• Graphviz Include Graphs

Indices and tables

• Index

• Module Index

• Search Page