- Generated by
1.11.0
|
SPARK
0.1.0
A general purpose game engine written in C++.
|
| ▼Nexperimental | |
| ►Nser | |
| CSerializerScheme< SerializerType, spark::core::GameObject > | |
| CSerializerScheme< SerializerType, spark::core::Scene > | |
| CSerializerScheme< SerializerType, spark::math::Rectangle< T > > | |
| CSerializerScheme< SerializerType, spark::math::Vector2< T > > | |
| CSerializerScheme< SerializerType, std::filesystem::path > | |
| CSerializerScheme< SerializerType, std::optional< T > > | |
| ▼Nspark | |
| ►Naudio | |
| CSound | A class representing a sound that can be played |
| ►Nbase | |
| ►Ndetails | |
| CException | The base class for all exceptions in Spark. Should be used as a base class only |
| CArgumentOutOfRangeException | Exception thrown when an argument is out of range |
| CBadArgumentException | Exception thrown when an argument is not valid |
| CBadWindowInitializationException | Exception thrown when failing to initialize a window |
| CCommandBufferAlreadyRecordingException | Exception thrown when starting a command buffer recording while it is already recording |
| CCouldNotCreateShaderException | Exception thrown when failing to create a shader |
| CCouldNotObtainFileLockException | Exception thrown on failure when trying to obtain a lock on a file. This can occurs on several situations: |
| CCouldNotOpenFileException | Exception thrown when trying to open a file that could not be opened. This can occurs on several situations: |
| CDuplicatedApplicationException | Exception thrown when trying to create multiple instances of an application, which is not allowed |
| CFileIOException | Exception thrown when an I/O operation on a file could not be achieved |
| CInvalidDescriptorTypeException | Exception thrown when a descriptor does not have the expected type |
| CNotImplementedException | Exception thrown when a functionality which is not implemented yet is called |
| CNullPointerException | Exception thrown when a pointer is null and should't be |
| COverflowException | Exception thrown when trying to read/write past the end of a buffer |
| CRenderPassAlreadyStartedException | Exception thrown when calling a function which requires a render pass to be ended while it is not |
| CRenderPassNotStartedException | Exception thrown when calling a function which requires a render pass to be started while it is not |
| CTypeMismatchException | Exception thrown when an argument does not have the expected type |
| CUninitializedSocketException | Exception thrown when trying to manipulate an uninitialized socket |
| CUnknownException | Exception thrown when something strange happened and we have no idea of why this is happening. This is an unexpected exception which means there is a software failure somewhere |
| CUnsupportedFileFormatException | Exception thrown when trying to load a file with an unsupported format |
| CWrongSerializerMode | Exception thrown when trying to serialize an object when the serializer is not in writing mode or vice versa |
| ►Ncore | |
| ►Ncomponents | |
| CCircle | A simple component to render a circle |
| CCollider | A component representing a square collider |
| CDynamicCollider | A square collider that moves and checks for collisions with other colliders |
| CImage | A simple component to render an image |
| CRectangle | A simple component to render a square/rectangle |
| CStaticCollider | A square collider that does not move and is only used for collision detection |
| CText | |
| CTransform | A component that stores the position of a game object |
| ►Ndetails | |
| ►Napplication_tags | |
| Cset_name_called | |
| Cset_resize_policy | |
| Cset_size_called | |
| CAbstractGameObject | A CRTP class to implement a GameObject. It is used to wrap the onSpawn, onUpdate and onDestroyed methods to include custom code around user implementation |
| CGameObjectDeleter | Deleter used to call the onDestroyed method on the implementation of a GameObject |
| ►CApplication | A class representing a SPARK application |
| CRegistries | A struct containing all the registries for the application |
| CSettings | A struct containing the settings for the application |
| CApplicationBuilder | |
| CComponent | A component that can be attached to a GameObject to provide additional functionality |
| CComponentRegistry | A registry used to create Component instances and get serialization objects for it |
| CGameObject | A GameObject is any object in the game. It contains a list of components that provides functionality to the GameObject |
| CGameObjectRegistry | A registry used to create GameObject instances and get serialization objects for it |
| CInput | A static class giving access to real-time input |
| CRenderer2D | An object that can render 2D graphics on a surface |
| CScene | |
| CSceneManager | A class used to manage scenes in the game |
| ►CWindow | An interface representing any window of any platform |
| CSettings | A struct containing the settings used to create a window |
| ►Nevents | |
| CEvent | A base class for all events in SPARK |
| CEventDispatcher | A class that dispatches events to the appropriate event handler |
| CKeyEvent | A base class for all key events |
| CKeyPressedEvent | A class that represents a key pressed event |
| CKeyReleasedEvent | A class that represents a key released event |
| CKeyTypedEvent | A class that represents a key typed event |
| CMouseButtonEvent | A base class for all mouse button events |
| CMouseButtonPressedEvent | A class representing a mouse button pressed event |
| CMouseButtonReleasedEvent | A class representing a mouse button released event |
| CMouseMovedEvent | A class representing a mouse moved event |
| CMouseScrolledEvent | A class representing a mouse scrolled event |
| CWindowCloseEvent | A class representing a window close event |
| CWindowResizeEvent | A class representing a window resize event |
| ►Nlib | |
| CClock | A class that can be used to measure time like a stopwatch |
| Coverloaded | Helper structure to pass a list of lambdas to a function (like std::visit) |
| CRandom | A class that provides random generation |
| CUuid | A 128-bit universally unique identifier (UUID) |
| CUuidGenerator | Generates UUIDs from C++11 <random> module |
| ►Nmath | |
| ►Ndetails | |
| CVector | |
| CRectangle | Represents a rectangle in 2D space |
| CVector2 | A vector with two components |
| CVector3 | A vector with three components |
| CVector4 | A vector with four components |
| ►Nmpl | |
| ►Ntype_seq | |
| Cat | |
| Cat< 0, C< Head, Ts... > > | |
| Cat< N, C< Head, Ts... > > | |
| Cback | |
| Cback< Head > | |
| Cback< Head, Ts... > | |
| Cconcat | |
| Cconcat< C< Ts... > > | |
| Cconcat< C< Ts... >, C< Us... > > | |
| Cconcat< T, U, V, O... > | |
| Ccontains | |
| Ccontains< T > | |
| Ccontains< T, Head, Ts... > | |
| Cconvert | |
| Cempty | |
| Cerase | |
| Cerase< T, C< Head, Ts... > > | |
| Cerase< T, C< T, Ts... > > | |
| Cerase_at | |
| Cerase_at< 0, C< Head, Ts... > > | |
| Cerase_at< N, C< Head, Ts... > > | |
| Cfilter | |
| Cfilter< Predicate, C< Head, Ts... > > | |
| Cfilter< Predicate, C<> > | |
| Cfind | |
| Cfind< T, C< Head, Ts... > > | |
| Cfind< T, C< T, Ts... > > | |
| Cflatten | |
| Cflatten< C< Ts... > > | |
| Cflatten< C<> > | |
| Cfront | |
| Cfront< Head, Ts... > | |
| Cindex_of | |
| Cindex_of< T > | |
| Cindex_of< T, Head, Ts... > | |
| Cinsert_at | |
| Cinsert_at< 0, T, C< Head, Ts... > > | |
| Cinsert_at< N, T, C< Head, Ts... > > | |
| Cinsert_at< N, T, C<> > | |
| Cmatch | |
| Cmatch< Matcher, C< T, Ts... >, C< U, Us... > > | |
| Cmatch< Matcher, C<>, C<> > | |
| Cpop_back | |
| Cpop_back< C< Head > > | |
| Cpop_back< C< Head, Ts... > > | |
| Cpop_front | |
| Cpop_front< C< Head, Ts... > > | |
| Cpush_back | |
| Cpush_back< T, C< Ts... > > | |
| Cpush_front | |
| Cpush_front< T, C< Ts... > > | |
| Creplace | |
| Creplace< T, U, C< Head, Ts... > > | |
| Creplace< T, U, C< T, Head, Ts... > > | |
| Creplace< T, U, C< T, Ts... > > | |
| Creplace< T, U, C<> > | |
| Creplace_at | |
| Creplace_at< 0, T, C< Head, Ts... > > | |
| Creplace_at< N, T, C< Head, Ts... > > | |
| Creplace_at< N, T, C<> > | |
| Creverse | |
| Creverse< C< Head, Ts... >, TypesToAdd... > | |
| Creverse< C<>, TypesToAdd... > | |
| Csize | |
| Ctransform | |
| Ctransform< F, C< Head, Ts... > > | |
| Ctransform< F, C<> > | |
| Ctypelist | |
| Ctypelist< First, Ts... > | |
| Ctypelist<> | |
| Ctypelist_base | |
| ►Npatterns | |
| ►Ndetails | |
| CBaseCreator | A base class for all creators |
| CConnection | |
| Cconvertible_or_same | |
| CDerivedCreator | The creator for a derived class |
| CTreeTraverserCaller | A generic tree traverser caller that can be used to traverse any Composite |
| CComposite | |
| CFactory | A factory class that creates objects of type BaseType |
| CSignal | A signal is a class used to emit events |
| CSlot | A slot is a connection between a signal and a callback |
| CTraverser | A base class for any traverser used by the traverse_tree function |
| ►Nrender | |
| ►Nvk | |
| CDescriptorInfo | |
| CDescriptorSetInfo | |
| CIVulkanBuffer | Vulkan interface for a IBuffer |
| CIVulkanImage | Represents a Vulkan image |
| CIVulkanIndexBuffer | Vulkan interface for an IIndexBuffer |
| CIVulkanSampler | Interface for Vulkan sampler |
| CIVulkanVertexBuffer | Vulkan interface for a IVertexBuffer |
| CPushConstantRangeInfo | |
| CQueueFamily | |
| ►CVulkanBackend | Vulkan implementation of IRenderBackend |
| CImpl | |
| ►CVulkanBuffer | Vulkan implementation of IBuffer |
| CImpl | |
| ►CVulkanCommandBuffer | Vulkan implementation of ICommandBuffer |
| CImpl | |
| ►CVulkanDescriptorLayout | Implements a Vulkan IDescriptorLayout |
| CImpl | |
| ►CVulkanDescriptorSet | Vulkan implementation of IDescriptorSet |
| CImpl | |
| ►CVulkanDescriptorSetLayout | Vulkan implementation of IDescriptorSetLayout |
| CImpl | |
| ►CVulkanDevice | Vulkan implementation of IGraphicsDevice |
| CImpl | |
| ►CVulkanFactory | Vulkan implementation of IGraphicsFactory |
| CImpl | |
| ►CVulkanFrameBuffer | Vulkan implementation of IFrameBuffer |
| CImpl | |
| ►CVulkanGraphicsAdapter | Implementation of IGraphicsAdapter for Vulkan |
| CImpl | |
| ►CVulkanImage | Vulkan implementation of IImage |
| CImpl | |
| ►CVulkanIndexBuffer | Vulkan implementation of an IIndexBuffer |
| CImpl | |
| ►CVulkanIndexBufferLayout | Implements IIndexBufferLayout for Vulkan |
| CImpl | |
| ►CVulkanInputAssembler | Vulkan implementation of IInputAssembler |
| CImpl | |
| ►CVulkanInputAttachmentMapping | Vulkan implementation of IInputAttachmentMapping |
| CImpl | |
| ►CVulkanPipelineLayout | Vulkan implementation of IPipelineLayout |
| CImpl | |
| CVulkanPipelineState | Vulkan implementation of IPipeline |
| ►CVulkanPushConstantsLayout | Vulkan implementation of IPushConstantsLayout |
| CImpl | |
| ►CVulkanPushConstantsRange | Vulkan implementation of IPushConstantsRange |
| CImpl | |
| ►CVulkanQueue | Vulkan implementation of ICommandQueue |
| CImpl | |
| CVulkanRasterizer | Vulkan implementation of IRasterizer |
| ►CVulkanRenderPass | Vulkan implementation of IRenderPass |
| CImpl | |
| ►CVulkanRenderPipeline | Vulkan implementation of IRenderPipeline |
| CImpl | |
| ►CVulkanSampler | Vulkan implementation of ISampler |
| CImpl | |
| ►CVulkanShaderModule | Vulkan implementation of a IShaderModule |
| CImpl | |
| ►CVulkanShaderProgram | Vulkan implementation of a ShaderProgram |
| CImpl | |
| ►CVulkanSurface | Implementation of ISurface for Vulkan |
| CImpl | |
| ►CVulkanSwapChain | Vulkan implementation of ISwapChain |
| CImpl | |
| ►CVulkanVertexBuffer | Vulkan implementation of a IVertexBuffer |
| CImpl | |
| ►CVulkanVertexBufferLayout | Implements IVertexBufferLayout for Vulkan |
| CImpl | |
| ►CBufferAttribute | Stores metadata about a buffer attribute, member or field of a descriptor or buffer |
| CImpl | |
| CCommandBuffer | |
| CCommandQueue | Represents a ICommandQueue |
| ►CDepthStencilState | Stores the depth/stencil state of a see IRasterizer |
| CDepthBias | Describes the rasterizer depth bias |
| CDepthState | Describes the depth test state |
| CImpl | |
| CStencilState | Describes the rasterizer stencil state |
| CStencilTest | Describes a stencil test for either front or back faces |
| CDescriptorBinding | Describes a resource binding in a descriptor set |
| CDescriptorSet | Defines a set of descriptors |
| CDescriptorSetLayout | Describes the layout of a descriptor set |
| ►CDeviceState | A class used to manage the state of a IGraphicsDevice |
| CImpl | |
| CFrameBuffer | Stores the images for the output attachments for a back buffer of a IRenderPass>, as well as a CommandBuffer instance, that records draw commands |
| CGraphicsDevice | Represents the graphics device that a rendering back-end is doing work on |
| CGraphicsFactory | Describes a factory that creates objects for a IGraphicsDevice |
| CIBackend | The base class for a backend |
| CIBuffer | Base interface for all buffers |
| CIBufferLayout | Describes the layout of a buffer |
| CICommandBuffer | Interface for a command buffer |
| CICommandQueue | Interface for a command queue |
| CIDescriptorLayout | Describes a the layout of a single descriptor within a DescriptorSet |
| CIDescriptorSet | Interface for a descriptor set |
| CIDescriptorSetLayout | Interface for a descriptor set layout |
| CIDeviceMemory | Describes a chunk of memory on the GPU |
| CIFrameBuffer | Interface for a frame buffer |
| CIGraphicsAdapter | Represents a physical graphics adapter |
| CIGraphicsDevice | Interface for a graphics device |
| CIGraphicsFactory | |
| CIImage | |
| CIIndexBuffer | Describes an index buffer |
| CIIndexBufferLayout | Describes the layout of an index buffer |
| CIInputAssembler | |
| CIMappable | Interface allowing data to be mapped into the object |
| CInputAssembler | Represents a the input assembler state of a IRenderPipeline |
| CInputAttachmentMapping | |
| CInputAttachmentMappingSource | Represents the source for an input attachment mapping |
| CIPipeline | Interface representing a pipeline |
| CIPipelineLayout | Interface for pipeline layouts |
| CIPushConstantsLayout | Interface for a push constants layout |
| CIPushConstantsRange | Interface for a push constants range in a push constants layout |
| CIRasterizer | Represents the rasterizer stage of the graphics pipeline |
| CIRenderBackend | Describes a rendering backend. (backend with type BackendType::Rendering) |
| CIRenderPass | Interface for a render pass |
| CIRenderPipeline | Interface for a render pipeline |
| ►CIRenderTarget | Represents a render target, which is an abstract view of the output of a RenderPass. A render target represents one output of a render pass, stored within an IImage. It is contained by a RenderPass, that contains the FrameBuffer, that stores the actual render target image resource |
| CBlendState | Describes the blend state of a render target |
| CIResource | Provides access to a resource managed by the derived class |
| CISampler | Describes a texture sampler |
| CIScissor | Interface representing a scissor |
| CIShaderModule | Interface representing a single shader module, a part of a IShaderProgram |
| CIShaderProgram | Interface representing a shader program, a collection of IShaderModule |
| CIStateResource | Interface for a state resource |
| CISurface | Represents a surface to render to. A surface can be seen as a window or area on the screen where the renderer can draw to |
| CISwapChain | Interface for a swap chain, a chain of multiple IImage instances that can be presented using a ISurface |
| CIVertexBuffer | Represents a vertex buffer |
| CIVertexBufferLayout | Describes the layout of a vertex buffer |
| CIViewport | Interface representing a viewport |
| CPipeline | Represents a pipeline state |
| CPipelineLayout | Represents a the layout of a RenderPipeline |
| CPushConstantsLayout | Describes the layout of the pipelines push constant ranges |
| ►CRasterizer | Implements the IRasterizer interface |
| CImpl | |
| CRenderBackend | Defines a back-end, that provides a device instance for a certain surface and graphics adapter |
| CRenderPass | Represents a render pass |
| CRenderPipeline | Represents a graphics IPipeline |
| ►CRenderTarget | Implements a IRenderTarget |
| CImpl | |
| CResource | |
| ►CScissor | Implementation of IScissor |
| CImpl | |
| CShaderProgram | Represents a shader program with a specific type of IShaderModule |
| ►CStateResource | Base class for a resource that can be identified by a name in a DeviceState |
| CImpl | |
| CSwapChain | Represents a swap chain, i.e. a chain of multiple IImage instances, that can be presented to a ISurface |
| ►CViewport | Implementation of IViewport |
| CImpl | |
| ►Nrtti | |
| ►Ndetails | |
| CGetClassName | |
| CGetParentRtti | |
| CGetParentRtti<> | |
| CHasRtti | The class anything using the RTTI should implement |
| CRtti | The RTTI object containing all the needed data |
| CRttiBase | The abstract class used as base for the RTTI data |
| CRttiDatabase | |
| ▼Nstd | |
| Cformatter< spark::render::BufferFormat > | |
| Cformatter< spark::render::BufferType > | |
| Cformatter< spark::render::CullMode > | |
| Cformatter< spark::render::CullOrder > | |
| Cformatter< spark::render::DescriptorType > | |
| Cformatter< spark::render::Format > | |
| Cformatter< spark::render::GraphicsAdapterType > | |
| Cformatter< spark::render::MultiSamplingLevel > | |
| Cformatter< spark::render::PolygonMode > | |
| Cformatter< spark::render::PrimitiveTopology > | |
| Cformatter< spark::render::ShaderStage > | |
| Cformatter< SpvReflectResult > | |
| Cformatter< VkResult > | |
| Chash< spark::lib::Uuid > | |
| Chash< spark::math::Vector2< T > > | |
| Chash< spark::math::Vector3< T > > | |
| Chash< spark::math::Vector4< T > > | |
| CRtti |
1.11.0