C++ Code Documentation

Page Hierarchy

• • Todo List

File Hierarchy

• • Directory inexor
    • Directory vulkan-renderer
      • Directory input
        • File gamepad_data.hpp
        • File input.hpp
        • File keyboard_mouse_data.hpp
      • Directory octree
        • Directory serialization
          • File byte_stream.hpp
          • File nxoc_parser.hpp
          • File octree_parser.hpp
        • File collision.hpp
        • File collision_query.hpp
        • File cube.hpp
        • File indentation.hpp
      • Directory tools
        • Directory allocators
          • File pool_allocator.hpp
        • File camera.hpp
        • File device_info.hpp
        • File enumerate.hpp
        • File exception.hpp
        • File file.hpp
        • File fps_limiter.hpp
        • File queue_selection.hpp
        • File random.hpp
        • File representation.hpp
        • File time_step.hpp
      • Directory wrapper
        • Directory commands
          • File command_buffer.hpp
          • File command_pool.hpp
        • Directory descriptors
          • File descriptor.hpp
          • File descriptor_builder.hpp
        • Directory pipelines
          • File graphics_pipeline.hpp
          • File graphics_pipeline_builder.hpp
          • File pipeline_cache.hpp
          • File pipeline_layout.hpp
        • Directory swapchains
          • File swapchain.hpp
          • File swapchain_utils.hpp
        • Directory synchronization
          • File fence.hpp
          • File semaphore.hpp
        • Directory windows
          • File surface.hpp
          • File window.hpp
        • File cpu_texture.hpp
        • File debug_callback.hpp
        • File device.hpp
        • File framebuffer.hpp
        • File gpu_memory_buffer.hpp
        • File gpu_texture.hpp
        • File image.hpp
        • File instance.hpp
        • File make_info.hpp
        • File shader.hpp
        • File uniform_buffer.hpp
      • File imgui.hpp
      • File render_graph.hpp

Full API

Namespaces

• Namespace inexor
  • Namespaces

• Namespace inexor::vulkan_renderer
  • Namespaces
  • Classes
  • Enums

• Namespace inexor::vulkan_renderer::input
  • Classes

• Namespace inexor::vulkan_renderer::octree
  • Classes
  • Functions
  • Typedefs

• Namespace inexor::vulkan_renderer::render_graph

• Namespace inexor::vulkan_renderer::serialization
  • Classes

• Namespace inexor::vulkan_renderer::tools
  • Namespaces
  • Classes
  • Enums
  • Functions
  • Variables

• Namespace inexor::vulkan_renderer::tools::allocators
  • Classes
  • Unions

• Namespace inexor::vulkan_renderer::tools::directions
  • Variables

• Namespace inexor::vulkan_renderer::wrapper
  • Namespaces
  • Classes
  • Enums
  • Functions

• Namespace inexor::vulkan_renderer::wrapper::commands
  • Classes

• Namespace inexor::vulkan_renderer::wrapper::descriptors
  • Classes

• Namespace inexor::vulkan_renderer::wrapper::pipelines
  • Classes

• Namespace inexor::vulkan_renderer::wrapper::swapchains
  • Classes
  • Functions

• Namespace inexor::vulkan_renderer::wrapper::synchronization
  • Classes

• Namespace inexor::vulkan_renderer::wrapper::windows
  • Classes
  • Enums

• Namespace std

Classes and Structs

• Struct ImGUIOverlay::PushConstBlock
  • Nested Relationships
  • Struct Documentation

• Struct Cube::RotationAxis
  • Nested Relationships
  • Struct Documentation

• Struct RenderGraphObject
  • Inheritance Relationships
    • Derived Types
  • Struct Documentation

• Struct DeviceInfo
  • Struct Documentation

• Struct QueueFamilyIndexCandidates
  • Struct Documentation

• Class BufferResource
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class GraphicsStage
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class ImGUIOverlay
  • Nested Relationships
    • Nested Types
  • Class Documentation

• Class GamepadInputData
  • Class Documentation

• Class Input
  • Class Documentation

• Class KeyboardMouseInputData
  • Class Documentation

• Class Cube
  • Nested Relationships
    • Nested Types
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class Indentation
  • Class Documentation

• Template Class RayCubeCollision
  • Class Documentation

• Class PhysicalBackBuffer
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class PhysicalBuffer
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class PhysicalGraphicsStage
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class PhysicalImage
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class PhysicalResource
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation

• Class PhysicalStage
  • Inheritance Relationships
    • Base Type
    • Derived Type
  • Class Documentation

• Class RenderGraph
  • Class Documentation

• Class RenderResource
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation

• Class RenderStage
  • Inheritance Relationships
    • Base Type
    • Derived Type
  • Class Documentation

• Class ByteStream
  • Inheritance Relationships
    • Derived Type
  • Class Documentation

• Class ByteStreamReader
  • Class Documentation

• Class ByteStreamWriter
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class NXOCParser
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class OctreeParser
  • Inheritance Relationships
    • Derived Type
  • Class Documentation

• Class TextureResource
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Template Class PoolAllocator
  • Class Documentation

• Class Camera
  • Class Documentation

• Class FPSLimiter
  • Class Documentation

• Class InexorException
  • Inheritance Relationships
    • Base Type
    • Derived Type
  • Class Documentation

• Class TimeStep
  • Class Documentation

• Class VulkanException
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class CommandBuffer
  • Class Documentation

• Class CommandPool
  • Class Documentation

• Class CpuTexture
  • Class Documentation

• Class DescriptorBuilder
  • Class Documentation

• Class ResourceDescriptor
  • Class Documentation

• Class Device
  • Class Documentation

• Class Framebuffer
  • Class Documentation

• Class GPUMemoryBuffer
  • Inheritance Relationships
    • Derived Type
  • Class Documentation

• Class GpuTexture
  • Class Documentation

• Class Image
  • Class Documentation

• Class Instance
  • Class Documentation

• Class GraphicsPipeline
  • Class Documentation

• Class GraphicsPipelineBuilder
  • Class Documentation

• Class PipelineCache
  • Class Documentation

• Class PipelineLayout
  • Class Documentation

• Class Shader
  • Class Documentation

• Class Swapchain
  • Class Documentation

• Class Fence
  • Class Documentation

• Class Semaphore
  • Class Documentation

• Class UniformBuffer
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class VulkanDebugUtilsCallback
  • Class Documentation

• Class Window
  • Class Documentation

• Class WindowSurface
  • Class Documentation

Enums

• Enum BufferUsage
  • Enum Documentation

• Enum TextureUsage
  • Enum Documentation

• Enum CameraMovement
  • Enum Documentation

• Enum CameraType
  • Enum Documentation

• Enum VulkanQueueType
  • Enum Documentation

• Enum Mode
  • Enum Documentation

Unions

• Union PoolChunk
  • Union Documentation

Functions

• Function inexor::vulkan_renderer::octree::create_random_world
  • Function Documentation

• Function inexor::vulkan_renderer::octree::ray_box_collision
  • Function Documentation

• Function inexor::vulkan_renderer::octree::ray_cube_collision_check
  • Function Documentation

• Template Function inexor::vulkan_renderer::tools::as_string
  • Function Documentation

• Function inexor::vulkan_renderer::tools::build_device_info
  • Function Documentation

• Function inexor::vulkan_renderer::tools::compare_physical_devices
  • Function Documentation

• Function inexor::vulkan_renderer::tools::determine_queue_family_indices
  • Function Documentation

• Function inexor::vulkan_renderer::tools::device_type_rating
  • Function Documentation

• Function inexor::vulkan_renderer::tools::get_device_feature_description
  • Function Documentation

• Function inexor::vulkan_renderer::tools::get_device_features_as_vector
  • Function Documentation

• Function inexor::vulkan_renderer::tools::get_extension_properties
  • Function Documentation

• Function inexor::vulkan_renderer::tools::get_file_extension_lowercase
  • Function Documentation

• Function inexor::vulkan_renderer::tools::get_instance_extensions
  • Function Documentation

• Function inexor::vulkan_renderer::tools::get_instance_layers
  • Function Documentation

• Function inexor::vulkan_renderer::tools::get_physical_device_name
  • Function Documentation

• Function inexor::vulkan_renderer::tools::get_physical_devices
  • Function Documentation

• Function inexor::vulkan_renderer::tools::get_queue_family_properties
  • Function Documentation

• Function inexor::vulkan_renderer::tools::get_surface_formats
  • Function Documentation

• Function inexor::vulkan_renderer::tools::get_surface_present_modes
  • Function Documentation

• Template Function inexor::vulkan_renderer::tools::get_vk_debug_report_object_type
  • Function Documentation

• Template Function inexor::vulkan_renderer::tools::get_vk_object_type
  • Function Documentation

• Function inexor::vulkan_renderer::tools::is_extension_supported
  • Function Documentation

• Function inexor::vulkan_renderer::tools::is_gpu_suitable
  • Function Documentation

• Template Function inexor::vulkan_renderer::tools::parse_bit_flags
  • Function Documentation

• Function inexor::vulkan_renderer::tools::pick_best_physical_device(std::vector<DeviceInfo>&&, const VkPhysicalDeviceFeatures&, const std::span<const char *>)
  • Function Documentation

• Function inexor::vulkan_renderer::tools::pick_best_physical_device(const Instance&, VkSurfaceKHR, const VkPhysicalDeviceFeatures&, const std::span<const char *>)
  • Function Documentation

• Function inexor::vulkan_renderer::tools::read_file_binary_data
  • Function Documentation

• Function inexor::vulkan_renderer::tools::result_to_description
  • Function Documentation

• Function inexor::vulkan_renderer::wrapper::is_instance_extension_supported
  • Function Documentation

• Function inexor::vulkan_renderer::wrapper::is_instance_layer_supported
  • Function Documentation

• Template Function inexor::vulkan_renderer::wrapper::make_info
  • Function Documentation

• Function inexor::vulkan_renderer::wrapper::swapchains::choose_array_layers
  • Function Documentation

• Function inexor::vulkan_renderer::wrapper::swapchains::choose_composite_alpha
  • Function Documentation

• Function inexor::vulkan_renderer::wrapper::swapchains::choose_image_count
  • Function Documentation

• Function inexor::vulkan_renderer::wrapper::swapchains::choose_image_extent
  • Function Documentation

• Function inexor::vulkan_renderer::wrapper::swapchains::choose_image_usage
  • Function Documentation

• Function inexor::vulkan_renderer::wrapper::swapchains::choose_present_mode
  • Function Documentation

• Function inexor::vulkan_renderer::wrapper::swapchains::choose_surface_format
  • Function Documentation

• Function inexor::vulkan_renderer::wrapper::swapchains::choose_transform
  • Function Documentation

• Function swap
  • Function Documentation

Variables

• Variable inexor::vulkan_renderer::tools::DEFAULT_QUEUE_PRIORITY
  • Variable Documentation

• Variable inexor::vulkan_renderer::tools::directions::DEFAULT_FRONT
  • Variable Documentation

• Variable inexor::vulkan_renderer::tools::directions::DEFAULT_RIGHT
  • Variable Documentation

• Variable inexor::vulkan_renderer::tools::directions::DEFAULT_UP
  • Variable Documentation

• Variable inexor::vulkan_renderer::tools::generate_random_number
  • Variable Documentation

Typedefs

• Typedef inexor::vulkan_renderer::octree::Polygon
  • Typedef Documentation

• Typedef inexor::vulkan_renderer::octree::PolygonCache
  • Typedef Documentation