TheAtlasEngine API Documentation
Welcome to TheAtlasEngine documentaiton
This section provides a detailed documentation for classes, files, namespace, and other API's from the atlas project.
Contents
Here are the main entry points to the generated documentation:
- Annotated Index: A comprehensive, alphabetically sorted list of all documented entities.
- Files: Browse documentation by source file.
- Namespaces: Explore the engine's structure through its namespaces.
- Classes: A direct list of all documented classes.
- Hierarchy: View the class inheritance hierarchy.
- Modules: Organized groups of related entities (if defined in Doxygen).
- Related Pages: Additional informational pages (if defined in Doxygen).
Detailed References
Below is a detailed breakdown of individual components within the engine, organized by type.
Classes and Structs
- DescriptorSet
- DescriptorSetLayout
- DirectionalLightUbo
- Framebuffer
- Image
- ImageSampler
- ParallelUpdateManager
- Pipeline
- PointLightUbo
- SpotLightUbo
- UniformBuffer
- VulkanImGui
- application
- application_settings
- box_collider3d
- camera
- camera_ubo
- console_log_manager
- entity_t
- joystick_button
- joystick_info
- imgui_backend
- index_buffer
- interpolation
- light
- math_generic
- matrix2
- matrix3
- matrix4
- mesh
- JoltPhysicBody
- jolt_config
- jolt_settings
- physics_engine
- render_context
- renderer
- renderpass
- renderpass_properties
- rendertarget3d
- rigidbody3d
- scene_object
- scene_scope
- serializer
- shader
- swapchain
- system_registry
- tag
- thread
- timer
- transform
- vector2
- vector3
- vector3< JPH::Vec3 >
- vector4
- vertex
- vertex_buffer
- BufferTutorial
- VulkanDescriptorSets
- VulkanPipeline
- VulkanRenderPass
- VulkanUniformBuffer
- descriptor_pool
- descriptor_pool::builder
- descriptor_set_layout
- descriptor_set_layout::builder
- descriptor_writer
- shader_pipeline_config
- vk_context
- vk_driver
- vk_index_buffer
- vk_physical_driver
- vk_physical_driver::queue_family_indices
- vk_renderer
- vk_shader
- vk_swapchain
- vk_vertex_buffer
- vk_window
- window
- world_scope
- vk_swapchain::swapchain_depth_image
- vk_swapchain::swapchain_image
Namespaces
Files
- event.hpp
- event.hpp Source
- joystick_codes.hpp
- joystick_codes.hpp Source
- key_codes.hpp
- key_codes.hpp Source
- mouse_codes.hpp
- mouse_codes.hpp Source
- file_dialog.hpp
- file_dialog.hpp Source
- mesh.hpp
- mesh.hpp Source
- stb_image.hpp
- stb_image.hpp Source
- math.hpp
- math.hpp Source
- core/math/types.hpp
- core/math/types.hpp Source
- components.hpp
- components.hpp Source
- entity.hpp
- entity.hpp Source
- scene.hpp
- scene.hpp Source
- scene_object.hpp
- scene_object.hpp Source
- world.hpp
- world.hpp Source
- serializer.hpp
- serializer.hpp Source
- system_registry.hpp
- system_registry.hpp Source
- core/threads/thread.hpp
- core/threads/thread.hpp Source
- widgets.hpp
- widgets.hpp Source
- global_update.hpp
- global_update.hpp Source
- parallel_update_manager.hpp
- parallel_update_manager.hpp Source
- sync_update.hpp
- sync_update.hpp Source
- thread_manager.hpp
- thread_manager.hpp Source
- update_handlers/timer.hpp
- update_handlers/timer.hpp Source
- hash.hpp
- hash.hpp Source
- api.hpp
- api.hpp Source
- application.hpp
- application.hpp Source
- core.hpp
- core.hpp Source
- engine_logger.hpp
- engine_logger.hpp Source
- timer.hpp
- timer.hpp Source
- window.hpp
- window.hpp Source
- imgui_backend.hpp
- imgui_backend.hpp Source
- vulkan_shader.hpp
- vulkan_shader.hpp Source
- vulkan_shader_pipeline_config.hpp
- vulkan_shader_pipeline_config.hpp Source
- buffer_tutorial.hpp
- buffer_tutorial.hpp Source
- descriptor_tutorial.hpp
- descriptor_tutorial.hpp Source
- drivers/vulkan/helper_functions.hpp
- drivers/vulkan/helper_functions.hpp Source
- drivers/vulkan/types.hpp
- drivers/vulkan/types.hpp Source
- utility.hpp
- utility.hpp Source
- vulkan-imports.hpp
- vulkan-imports.hpp Source
- vulkan_context.hpp
- vulkan_context.hpp Source
- vulkan_core.hpp
- vulkan_core.hpp Source
- vulkan_descriptors.hpp
- vulkan_descriptors.hpp Source
- vulkan_driver.hpp
- vulkan_driver.hpp Source
- vulkan_gpu.hpp
- vulkan_gpu.hpp Source
- vulkan_imgui.hpp
- vulkan_imgui.hpp Source
- vulkan_index_buffer.hpp
- vulkan_index_buffer.hpp Source
- vulkan_physical_driver.hpp
- vulkan_physical_driver.hpp Source
- vulkan_pipeline.hpp
- vulkan_pipeline.hpp Source
- vulkan_renderer.hpp
- vulkan_renderer.hpp Source
- vulkan_renderpass.hpp
- vulkan_renderpass.hpp Source
- vulkan_swapchain.hpp
- vulkan_swapchain.hpp Source
- vulkan_uniform_buffer.hpp
- vulkan_uniform_buffer.hpp Source
- vulkan_vertex_buffer.hpp
- vulkan_vertex_buffer.hpp Source
- vulkan_window.hpp
- vulkan_window.hpp Source
- descriptor_sets.hpp
- descriptor_sets.hpp Source
- frame_buffer.hpp
- frame_buffer.hpp Source
- image.hpp
- image.hpp Source
- index_buffer.hpp
- index_buffer.hpp Source
- pipeline.hpp
- pipeline.hpp Source
- render_pass.hpp
- render_pass.hpp Source
- renderer_backend.hpp
- renderer_backend.hpp Source
- shader.hpp
- shader.hpp Source
- swapchain.hpp
- swapchain.hpp Source
- uniform.hpp
- uniform.hpp Source
- uniform_buffer.hpp
- uniform_buffer.hpp Source
- vertex_buffer.hpp
- vertex_buffer.hpp Source
- physics/jolt-cpp/helper_functions.hpp
- physics/jolt-cpp/helper_functions.hpp Source
- jolt-imports.hpp
- jolt-imports.hpp Source
- jolt-cpp/jolt_api.hpp
- jolt-cpp/jolt_api.hpp Source
- jolt_body.hpp
- jolt_body.hpp Source
- jolt_config.hpp
- jolt_config.hpp Source
- jolt_settings.hpp
- jolt_settings.hpp Source
- physics_3d/jolt/jolt_api.hpp
- physics_3d/jolt/jolt_api.hpp Source
- jolt_physics_engine.hpp
- jolt_physics_engine.hpp Source
- physics_api.hpp
- physics_api.hpp Source
- physics_engine.hpp
- physics_engine.hpp Source
- physics/types.hpp
- physics/types.hpp Source
- renderer.hpp
- renderer.hpp Source
- thread_utils/thread.hpp
- thread_utils/thread.hpp Source
- thread_utils.hpp
- thread_utils.hpp Source
Other Appendices
- Class Members: A combined index of all class members.
- Namespace Members: A combined index of all namespace members.
- Global Functions
- Global Macros
- Global Variables
- Source Code Links (if generated)