Class Hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:

[detail level 12345]

Cforay::scene::Animation	Represents an animation, defined by atleast one channel affecting one node property each
Cforay::scene::AnimationChannel	A channel is the animation of a single node property
Cforay::scene::AnimationKeyframe	A set of values at a time point
Cforay::scene::AnimationSampler	A collection of keyframes
Cforay::base::AppFrameTiming	Controls an apps render scheduling timing
Cforay::core::ImageLayoutCache::Barrier	See VkImageMemoryBarrier
Cforay::core::ImageLayoutCache::Barrier2	See VkImageMemoryBarrier2
►Cforay::bench::BenchmarkBase	Base class for all benchmark types
Cforay::bench::DeviceBenchmark	A device benchmark based on Vulkans DeviceQuery Api. Timestamps are recorded in milliseconds. Timestamp names must be set in advance
Cforay::bench::HostBenchmark	A host (CPU time) benchmark based on std::chrono::high_resolution_clock. Timestamps are recorded in milliseconds
Cforay::bench::BenchmarkLog	Log of a single benchmark run. All timestamps given must be relative to the same base time
Cforay::bench::BenchmarkTimestamp	Timestamp combining a label / id with a timestamp in milliseconds
Cforay::as::BlasInstance	A reference to a BLAS maintained by the TLAS
Cforay::util::BufferSection
►Cforay::scene::CallbackDispatcher	Type maintaining callback lists for event distribution
Cforay::scene::Scene	Provides registries and methods as the anchor of a component based scene
Cforay::scene::CallbackDispatcher::CallbackVector< TCallback, Ordered >
Cforay::scene::CallbackDispatcher::CallbackVector< foray::scene::Component::DrawCallback >
Cforay::scene::CallbackDispatcher::CallbackVector< foray::scene::Component::OnEventCallback >
Cforay::scene::CallbackDispatcher::CallbackVector< foray::scene::Component::OnResizedCallback >
Cforay::scene::CallbackDispatcher::CallbackVector< foray::scene::Component::UpdateCallback >
Cforay::scene::CallbackDispatcher::CallbackVector< TCallback, true >
Cforay::scene::CameraUboBlock	Uniform buffer object layout for camera matrices
Cforay::util::ComponentTraits< COMPONENT_T, ALPHA_FALLBACK_, IS_FLOAT_, IS_SIGNED_ >	Describes the traits of a component type
Cforay::core::Context	Non owning context object
Cforay::core::ManagedBuffer::CreateInfo	Combines all structs used for initialization
Cforay::core::ManagedImage::CreateInfo	Combines all structs used for initialization
Cforay::base::DefaultAppBase	Intended as base class for demo applications. Compared to MinimalAppBase it offers a complete simple vulkan setup
Cforay::base::VulkanDevice::DefaultFeatures
Cforay::stages::DenoiserConfig	Config struct for initialization of denoiser stages
Cforay::core::DescriptorSet::DescriptorInfo
Cforay::scene::gcomp::DrawOp	Represents instanced draw operation of a single mesh
Cforay::scene::DrawPushConstant	Push Constant helper type
Cforay::scene::EmissiveTriangle	A reference to an emissive triangle
Cforay::rtpipe::RtShaderCollection::Entry
Cforay::util::EnvironmentMap	Experimental type loading an environment map in spherical representation, also generates mip maps
►Cstd::exception
Cforay::Exception	An extension of std::exception providing support for formatted error messages. Exceptions should always be catched via "catch (const std::exception& ex)", and thrown by value (Just use builtin static throw functions)
Cforay::util::impl::ExrLoaderCache
Cforay::base::FrameRenderInfo	Context used for render processes. This object is rebuilt for every frame. /
Cforay::base::RenderLoop::FrameTime
Cforay::base::RenderLoop::FrameTimeAnalysis	Analysis
Cforay::as::GeometryMeta	Meta information for a Geometry (gltf equivalent = Primitive). For use in raytracing shaders
Cforay::as::GeometryMetaBuffer	Device local buffer maintaining GeometryMeta structs for all primitives/geometries for multiple BLAS
Cstd::hash< foray::osi::Utf8Path >
Cforay::util::HistoryImage	Helper object managing a copy of an existing image for use as history information (reprojection etc.)
Cforay::util::ImageFormatTraits< FORMAT >	Describes the traits of a VkFormat value
Cforay::util::ImageFormatTraitsBase< COMPONENT_TRAITS_, COMPONENT_COUNT_ >	Trait base class assembled from component trait type and component count
Cforay::util::ImageFormatTraitsBase< ComponentTraits_Fp16, 1 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_Fp16, 2 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_Fp16, 3 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_Fp16, 4 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_Fp32, 1 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_Fp32, 2 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_Fp32, 3 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_Fp32, 4 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_Fp64, 1 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_Fp64, 2 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_Fp64, 3 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_Fp64, 4 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_UInt32, 1 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_UInt32, 2 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_UInt32, 3 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_UInt32, 4 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_UInt8, 1 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_UInt8, 2 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_UInt8, 3 >
Cforay::util::ImageFormatTraitsBase< ComponentTraits_UInt8, 4 >
Cforay::core::ImageLayoutCache	Tracks ImageLayouts over the course of a frame rendering process
Cforay::util::ImageLoader< FORMAT >	General purpose image loader
Cforay::core::ShaderManager::IncludeFile	Represents a file included (nested) in a shader compilation, but not compiled by itself
Cforay::gltf::ModelConverter::IndexBindings	Variables which determine how to map gltf-model indices to scene indices/pointers
Cforay::base::InFlightFrame	Wraps synchronization primitives and command buffers for an inflight frame
►Cforay::osi::InputBase	Base class for a single input channel of an input device
►Cforay::osi::InputAnalogue	Represents a single input with a state represented by a signed 16bit integer
Cforay::osi::InputDevice::AxisJoystick
►Cforay::osi::InputBinary	Represents a single input with a state represented by a boolean value
Cforay::osi::InputDevice::ButtonJoystick
Cforay::osi::InputDevice::ButtonKeyboard
Cforay::osi::InputDevice::ButtonMouse
►Cforay::osi::InputDirectional	Represents a stateless directional input
Cforay::osi::InputDevice::DirectionalMouseScroll
Cforay::osi::InputDevice	Wraps a generic input device (mouse, keyboard, joystick, controller ...) in a hardware agnostic way
Cforay::stages::ComparerStage::InputInfo	Argument struct for setting inputs
Cforay::scene::ncomp::FreeCameraController::InputStates
Cforay::scene::Material	Represents the default gltf pbr material type, capable of representing opaque surfaces with a metallic/roughness model including emission
Cforay::scene::Mesh	Type describing a single mesh object, described by multiple Primitive objects
Cforay::base::MinimalAppBase	Application base providing bare minimum of functionality (app lifetime, event handling, vulkan instance management)
Cforay::gltf::ModelConverterOptions	Options for converting glTF models to the integrated scene graph (foray::scene::Scene)
►Cforay::NoMoveDefaults	Simple types for supressing automatic definition of duplicating move constructors & operator
►Cforay::core::ManagedResource	Base class enforcing common interface for all classes wrapping a device resource
►Cforay::core::VulkanResource< VkObjectType::VK_OBJECT_TYPE_ACCELERATION_STRUCTURE_KHR >
Cforay::as::Blas	A Blas (Bottom Level Acceleration Structure) is the raytracing equivalent concept of a mesh
►Cforay::core::VulkanResource< VkObjectType::VK_OBJECT_TYPE_COMMAND_BUFFER >
►Cforay::core::CommandBuffer	VkCommandBuffer wrapper
Cforay::core::DeviceSyncCommandBuffer	Extension of the commandbuffer wrapper for device and/or host synchronized command buffer execution
Cforay::core::HostSyncCommandBuffer	Extension of the commandbuffer wrapper for temporary host synchronized command buffer execution
►Cforay::core::VulkanResource< VkObjectType::VK_OBJECT_TYPE_DESCRIPTOR_SET >
Cforay::core::DescriptorSet	Helps with the creation of a VkDescriptorSetLayout and VkDescriptorSet
►Cforay::core::VulkanResource< VkObjectType::VK_OBJECT_TYPE_BUFFER >
Cforay::core::ManagedBuffer	Wraps allocation and lifetime functionality of a VkBuffer
►Cforay::core::VulkanResource< VkObjectType::VK_OBJECT_TYPE_IMAGE >
Cforay::core::ManagedImage	Wraps allocation and lifetime functionality of VkImage
►Cforay::core::VulkanResource< VkObjectType::VK_OBJECT_TYPE_SAMPLER >
Cforay::core::SamplerCollection	Provides sampler objects based on VkSamplerCreateInfo specifications
►Cforay::core::VulkanResource< VkObjectType::VK_OBJECT_TYPE_SHADER_MODULE >
Cforay::core::ShaderModule	Wraps shader code driver handle (VkShaderModule). See ShaderManager for compiling shaders dynamically
►Cforay::core::VulkanResource< VkObjectType::VK_OBJECT_TYPE_SEMAPHORE >
Cforay::util::ExternalSemaphore	Timeline Semaphore exposing handles for synchronization with other Apis (e.g. Cuda for OptiX denoising)
►Cforay::core::VulkanResource< VkObjectType::VK_OBJECT_TYPE_PIPELINE_LAYOUT >
Cforay::util::PipelineLayout	Class that holds memory ownership of a vulkan pipeline layout
Cforay::util::ManagedVectorBuffer< foray::scene::Material >
Cforay::as::Tlas	Describes a top level accerlation structure. A tlas usually holds multiple Blas. A blas is an object/mesh instance together with its transformation in 3d space
Cforay::bench::DeviceBenchmark	A device benchmark based on Vulkans DeviceQuery Api. Timestamps are recorded in milliseconds. Timestamp names must be set in advance
Cforay::core::VulkanResource< OBJECT_TYPE >	ManagedResource variant which automates GetTypeName() overloading by returning a stringified version of VkObjectType
►Cforay::util::ManagedUboBase
Cforay::util::ManagedUbo< foray::scene::CameraUboBlock >
Cforay::util::ManagedUbo< T_UBO >	Template class for managing a UBO. For Host -> Device synchronization this utilises a DualBuffer
Cforay::util::ManagedVectorBuffer< TClass >	Class maintaining a resizable array of templated classes in a managed buffer
Cforay::util::NoiseSource	Uses std::mt19937_64 to generate a r32u image of decent quality random noise
Cforay::gltf::ModelConverter	Type which reads glTF files and merges a scene of the file into the scene graph
►Cforay::scene::Component	Base class for all types manageable by registry
►Cforay::scene::GlobalComponent
Cforay::scene::gcomp::AnimationManager	Handles storage and playback of animations
Cforay::scene::gcomp::CameraManager	Manages the Camera matrix buffer and maintains a list of cameras in the scene
Cforay::scene::gcomp::DrawDirector	Manages a collection of mesh instances, current and previous model matrices
Cforay::scene::gcomp::GeometryStore	Stores all geometry in a single set of index and vertex buffers
Cforay::scene::gcomp::LightManager	Maintains a list of PunctualLight components
Cforay::scene::gcomp::MaterialManager	Manages a device local storage buffer providing material information for rendering
Cforay::scene::gcomp::TextureManager	Manages textures and samplers
Cforay::scene::gcomp::TlasManager	Manages a Tlas for a scene
►Cforay::scene::NodeComponent
Cforay::scene::ncomp::Camera	Defines a camera with projection matrix
Cforay::scene::ncomp::FreeCameraController	A simple camera controller for free flight
Cforay::scene::ncomp::MeshInstance	Defines an instance of a mesh
Cforay::scene::ncomp::PunctualLight	Defines a simple punctual light (directional or point)
Cforay::scene::ncomp::Transform	Defines a nodes transform relative to its parent (or world origin, if no parent is set)
►Cforay::scene::Registry	Manages a type identified list of components
Cforay::scene::Node	A scene node. Extends the registry with hierarchical information
Cforay::scene::Scene	Provides registries and methods as the anchor of a component based scene
Cforay::util::DualBuffer	Helper class for organizing CPU -> GPU data synchronisation. In flight data is stored on host side, and copied to GPU right before being used
Cforay::util::ImageLoader< FORMAT >::ImageInfo
Cforay::osi::OsManager	Class of which a single instance needs to be present for interaction with the operating system via SDL
Cforay::stages::GBufferStage::PerImageInfo
Cforay::util::PipelineBuilder	Class to quickly build a default pipeline. Ownership is transfered to caller. TODO: THIS CLASS SHOULD BE REWORKED => all properties of the pipeline should be configurable, for example by exposing the underlying structs directly, instead of individual access methods
Cforay::stages::ComparerStage::PipetteValue
Cforay::scene::PlaybackConfig
►Cforay::Polymorphic	Simple type for forcing a type to be polymorphic
►Cforay::osi::Event	Base class for operating system events
►Cforay::osi::EventInput	Base class for events originating from input devices
Cforay::osi::EventInputAnalogue	Event type for an analogue input
Cforay::osi::EventInputBinary	Event type describing a binary input event
Cforay::osi::EventInputDeviceAvailability	Event type describing input devices being added or removed
Cforay::osi::EventInputDirectional	Event type describing a directional input event
Cforay::osi::EventInputMouseMoved	Event type describing a mouse cursor movement event
Cforay::osi::EventWindowCloseRequested	Event type fired when the windows closure is requested (by OS or user through OS)
Cforay::osi::EventWindowFocusChanged	Event type fired when a window gains or loses focus
Cforay::osi::EventWindowResized	Event type fired when a window is resized
Cforay::scene::Component	Base class for all types manageable by registry
►Cforay::scene::Component::DrawCallback	Base class for implementing the draw callback
Cforay::scene::gcomp::DrawDirector	Manages a collection of mesh instances, current and previous model matrices
►Cforay::scene::Component::OnEventCallback	Base class for implementing the onevent callback
Cforay::scene::ncomp::FreeCameraController	A simple camera controller for free flight
►Cforay::scene::Component::OnResizedCallback
Cforay::scene::ncomp::Camera	Defines a camera with projection matrix
►Cforay::scene::Component::UpdateCallback	Base class for implementing the update callback
Cforay::scene::gcomp::AnimationManager	Handles storage and playback of animations
Cforay::scene::gcomp::CameraManager	Manages the Camera matrix buffer and maintains a list of cameras in the scene
Cforay::scene::gcomp::DrawDirector	Manages a collection of mesh instances, current and previous model matrices
Cforay::scene::gcomp::LightManager	Maintains a list of PunctualLight components
Cforay::scene::gcomp::TlasManager	Manages a Tlas for a scene
Cforay::scene::ncomp::FreeCameraController	A simple camera controller for free flight
Cforay::scene::Primitive	"An object binding indexed or non-indexed geometry with a material." according to the glTF spec. It's a subset of a mesh and has its own set of vertices/indices as well as its own material. All mesh data is contained in one big buffer, so "First" is used to get the correct offset into the buffer
Cforay::stages::ComparerStage::PushConstant
Cforay::core::ManagedImage::QuickTransition	Helper struct translated to a VkImageMemoryBarrier2 struct for one-time layout transitions
Cforay::base::RenderLoop::RenderInfo
Cforay::base::RenderLoop	Manages a single threaded, automatically balancing application lifetime
►Cforay::stages::RenderStage	Render stage base class giving a common interface for rendering processes
►Cforay::stages::BlitStage	Stage which performs an image blit (more capable copy from one image to another)
Cforay::stages::ImageToSwapchainStage	The only purpose of this class is to copy the image onto the swapchain
Cforay::stages::ComparerStage	Displays two images of any type next to each other, and get a "pipette" readout at the mouse location
Cforay::stages::ComputeStageBase	Base class for compute shaders
Cforay::stages::DefaultRaytracingStageBase	Extended version of MinimalRaytracingStageBase limited to a single output image, descriptorset but providing built in support for scene (Camera, Tlas, Geometry, Materials), EnvironmentMap and Noise Texture
►Cforay::stages::DenoiserStage	Base class for denoiser implementations
Cforay::stages::ExternalDenoiserStage	Base class for externally computing denoiser implementations (e.g. OptiX Denoiser)
Cforay::stages::ImguiStage	The ImguiStage renders the imgui menu on top of an existing image or the swapchain. This image is passed via the backgroundImage
Cforay::stages::MinimalRaytracingStageBase	Minimalist setup for a Raytracing Stage
►Cforay::stages::RasterizedRenderStage	Base class for rasterized render stages (no built-in functionality)
Cforay::stages::GBufferStage	Utilizes rasterization to render a GBuffer output
Cforay::rtpipe::RtPipeline	Helper class wrapping 4 SBTs (Raygen, Miss, Callable, Hitgroup) and a raytracing pipeline
Cforay::rtpipe::RtShaderCollection	Helper class to manage unique Rt ShaderModules
Cforay::rtpipe::RtShaderEnumConversions	Enum conversion methods
Cforay::core::SamplerCollection::SamplerInstance
►Cforay::core::SamplerReference	Represents a reference to a VkSampler object managed by a SamplerCollection
Cforay::core::CombinedImageSampler	Wraps an image + sampler combination
Cforay::scene::SceneDrawInfo	Temporary type passed to components when drawing the scene
Cforay::scene::SceneUpdateInfo	Temporary type passed to components when updating the scene
Cforay::core::SemaphoreReference	Wraps a wait or signal semaphore action
►Cforay::rtpipe::ShaderBindingTableBase	Shader Binding Table base class, providing functions to manage custom generic shader group data and SBT building, aswell as buffer management
Cforay::rtpipe::GeneralShaderBindingTable	Shader binding table for storing raygen, miss and callable shader groups
Cforay::rtpipe::HitShaderBindingTable	Shader binding table implementation for storing hit groups (Consist of optional closesthit, anyhit and intersect shaders)
Cforay::core::ShaderManager::ShaderCompilation	Represents a unique shader compilation (input source path + config => Spirv file)
Cforay::core::ShaderCompilerConfig	Shader compile Options struct (moved out of class to fix clang & gcc compiler bug https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88165)
Cforay::rtpipe::GeneralShaderBindingTable::ShaderGroup	General shader group
Cforay::rtpipe::HitShaderBindingTable::ShaderGroup
Cforay::core::ShaderManager	Shader manager maintains a structure of shader compilations
Cforay::util::ShaderStageCreateInfos	Helper to create a simple set of shader stage create infos, that all use main as shader start point. Usage: Create object, add stages with modules, use local variable as in place vector
Cforay::scene::SimpleLight	Describes a simplified light source
Cforay::util::impl::StbLoaderCache
Cforay::stages::ComparerStage::SubStage	Value between 0...1 defining the split value
Cforay::core::SwapchainImageInfo	Collects information for a swapchain image
Cforay::scene::gcomp::TextureManager::Texture
Cforay::osi::Utf8Path	Utf8 encoded path wrapper
Cforay::rtpipe::ShaderBindingTableBase::VectorRange
Cforay::scene::Vertex	Vertex
Cforay::scene::VertexComponentBinding	Binding of component to shader input location
Cforay::scene::VertexInputStateBuilder	Helper for building a VkPipelineVertexInputStateCreateInfo struct
Cforay::base::VulkanDevice	Wraps selection and creation of a vulkan logical device
Cforay::base::VulkanInstance	Wraps creation and lifetime of a vulkan instance. Includes default debug callback logging setup
Cforay::base::VulkanWindowSwapchain	Combines Window, Surface and Swapchain into one managing object
Cforay::osi::Window	Window class. Provides access to common properties of operating system level windows