PrismEngine API

File Hierarchy

• • Directory PrismEngine
    • Directory src
      • File base.cpp
      • File base.h
      • File bufferWrapper.cpp
      • File bufferWrapper.h
      • File cameraComponent.h
      • File component.h
      • File componentManager.cpp
      • File componentManager.h
      • File config.h
      • File descriptorSet.cpp
      • File descriptorSet.h
      • File descriptorSetLayout.cpp
      • File descriptorSetLayout.h
      • File deviceChecker.cpp
      • File deviceChecker.h
      • File deviceRater.cpp
      • File deviceRater.h
      • File deviceWrapper.cpp
      • File deviceWrapper.h
      • File entity.h
      • File entityManager.cpp
      • File entityManager.h
      • File fmath.cpp
      • File fmath.h
      • File graphicsPipeline.cpp
      • File graphicsPipeline.h
      • File init.h
      • File logger.cpp
      • File logger.h
      • File matrix.cpp
      • File matrix.h
      • File mesh.h
      • File meshComponent.h
      • File meshLoader.cpp
      • File meshLoader.h
      • File meshManager.cpp
      • File meshManager.h
      • File PrismEngine.cpp
      • File PrismEngine.h
      • File prismGraphicCore.cpp
      • File prismGraphicCore.h
      • File renderer.cpp
      • File renderer.h
      • File renderPass.cpp
      • File renderPass.h
      • File renderSystem.cpp
      • File renderSystem.h
      • File resourcesCreater.cpp
      • File resourcesCreater.h
      • File scene.cpp
      • File scene.h
      • File shaderStagesLoader.cpp
      • File shaderStagesLoader.h
      • File stComponents.h
      • File stSystems.h
      • File swapChain.cpp
      • File swapChain.h
      • File system.h
      • File systemManager.cpp
      • File systemManager.h
      • File texture.h
      • File textureComponent.h
      • File textureLoader.cpp
      • File textureLoader.h
      • File textureManager.cpp
      • File textureManager.h
      • File transformComponent.h
      • File ubo.h
      • File utils.h
      • File vector.cpp
      • File vector.h
      • File vertex.cpp
      • File vertex.h
      • File Window.cpp
      • File Window.h

Full API

Namespaces

• Namespace prism
  • Namespaces
  • Classes
  • Functions
  • Typedefs
  • Variables

• Namespace prism::logger
  • Namespaces
  • Enums
  • Functions

• Namespace prism::logger::@27

• Namespace prism::math
  • Classes
  • Functions

• Namespace prism::PGC
  • Namespaces
  • Classes
  • Functions

• Namespace prism::PGC::base
  • Classes

• Namespace prism::PGC::utils
  • Classes
  • Enums

• Namespace prism::render
  • Classes

• Namespace prism::scene
  • Classes
  • Typedefs
  • Variables

Classes and Structs

• Struct Matrix4X4
  • Struct Documentation
    • prism::math::Matrix4X4
      • print()
      • operator[]()
      • operator==()
      • getTransposed()
      • m
      • makeIdentity()
      • makeRotationX()
      • makeRotationY()
      • makeRotationZ()
      • makeTranslation()
      • makeScale()
      • makeProjection()
      • Matrix_PointAt()

• Struct Vector3d
  • Struct Documentation
    • prism::math::Vector3d
      • Vector3d()
      • Vector3d()
      • print()
      • operator+()
      • operator-()
      • operator*()
      • operator/()
      • operator[]()
      • operator==()
      • length()
      • normalise()
      • x
      • y
      • z
      • w

• Struct CameraUBO
  • Struct Documentation
    • prism::PGC::CameraUBO
      • view
      • proj
      • viewProj
      • cameraPos

• Struct Color
  • Struct Documentation
    • prism::PGC::Color
      • r
      • g
      • b

• Struct DeviceScore
  • Struct Documentation
    • prism::PGC::DeviceScore
      • typeScore
      • featureScore
      • hardwareScore
      • apiScore

• Struct FeatureScores
  • Struct Documentation
    • prism::PGC::FeatureScores
      • swapchain
      • raytracing
      • upscaling
      • advancedFeatures

• Struct HardwareScore
  • Struct Documentation
    • prism::PGC::HardwareScore
      • vramGB
      • shaderCores
      • clockSpeedGHz
      • textureUnits
      • VRAM_WEIGHT
      • SHADER_CORES_WEIGHT
      • CLOCK_SPEED_WEIGHT
      • REFERENCE_VRAM_GB
      • REFERENCE_SHADER_CORES
      • REFERENCE_CLOCK_SPEED_GHZ

• Struct Mesh
  • Struct Documentation
    • prism::PGC::Mesh
      • vertexOffset
      • indexOffset
      • vertexCount
      • indexCount

• Struct MeshData
  • Struct Documentation
    • prism::PGC::MeshData
      • vertices
      • indices

• Struct ObjectUBO
  • Struct Documentation
    • prism::PGC::ObjectUBO
      • model
      • normals

• Struct PushConstants
  • Struct Documentation
    • prism::PGC::PushConstants
      • textureIndex

• Struct Texture
  • Struct Documentation
    • prism::PGC::Texture
      • path
      • mipLevels
      • image
      • imageView
      • imageMemory
      • sampler
      • width
      • height
      • channels
      • bindlessIndex

• Struct UniformBuffers
  • Struct Documentation
    • prism::PGC::UniformBuffers
      • camera
      • cameraMemory
      • cameraMapped
      • object
      • objectMemory
      • objectMapped

• Struct AppSettings
  • Struct Documentation
    • prism::PGC::utils::AppSettings
      • applicationName
      • applicationVersion

• Struct BindingConfig
  • Struct Documentation
    • prism::PGC::utils::BindingConfig
      • binding
      • descriptorType
      • descriptorCount
      • stageFlags
      • immutableSamplers

• Struct CameraData
  • Struct Documentation
    • prism::PGC::utils::CameraData
      • pos
      • look
      • up
      • fovy
      • aspect
      • zNear
      • zFar

• Struct ColorBlendAttachmentSettings
  • Struct Documentation
    • prism::PGC::utils::ColorBlendAttachmentSettings
      • blendEnable
      • colorWriteMask

• Struct ColorBlendSettings
  • Struct Documentation
    • prism::PGC::utils::ColorBlendSettings
      • attachments
      • logicOpEnable
      • logicOp
      • blendConstants

• Struct Context
  • Struct Documentation
    • prism::PGC::utils::Context
      • instance
      • surface
      • physicalDevice
      • device
      • graphicsQueue
      • presentQueue
      • vkSwapChain
      • swapChainImageViews
      • swapChainFramebuffers
      • swapChainImages
      • swapChainImageFormat
      • swapChainExtent
      • depthImage
      • depthImageMemory
      • depthImageView
      • colorImage
      • colorImageMemory
      • colorImageView
      • msaaSamples
      • renderPass
      • vertexBuffer
      • vertexBufferMemory
      • indexBuffer
      • indexBufferMemory
      • allVertices
      • allIndices
      • meshes
      • freeMeshIndices
      • meshBuffersDirty
      • descriptorSetLayout
      • pipelineLayout
      • graphicsPipeline
      • commandPool
      • commandBuffers
      • uniformBuffers
      • imageAvailableSemaphores
      • renderFinishedSemaphores
      • inFlightFences
      • currentFrame
      • imageIndex
      • wasRenderingActive
      • descriptorPool
      • textureDescriptorPool
      • textures
      • freeTextureIndices
      • textureDescriptorSet
      • textureDescriptorSetLayout
      • cameraData
      • descriptorSets
      • MAX_FRAMES_IN_FLIGHT
      • validationLayers
      • deviceExtensions
      • dynamicAlignment
      • MAX_OBJECTS
      • enableValidationLayers

• Struct DebugSettings
  • Struct Documentation
    • prism::PGC::utils::DebugSettings
      • VulkanMessageSeverity
      • VulkanMessageType
      • debugDeviceSelection

• Struct DepthStencilSettings
  • Struct Documentation
    • prism::PGC::utils::DepthStencilSettings
      • depthTestEnable
      • depthWriteEnable
      • depthCompareOp
      • depthBoundsTestEnable
      • minDepthBounds
      • maxDepthBounds
      • stencilTestEnable
      • front
      • back

• Struct DescriptorSetLayoutSettings
  • Struct Documentation
    • prism::PGC::utils::DescriptorSetLayoutSettings
      • bindings
      • flags

• Struct DeviceEvaluationWeightsSettings
  • Struct Documentation
    • prism::PGC::utils::DeviceEvaluationWeightsSettings
      • wType
      • wFeatures
      • wHardware
      • wApi

• Struct DynamicStateSettings
  • Struct Documentation
    • prism::PGC::utils::DynamicStateSettings
      • dynamicStates

• Struct InputAssemblySettings
  • Struct Documentation
    • prism::PGC::utils::InputAssemblySettings
      • topology
      • primitiveRestartEnable

• Struct MultisampleSettings
  • Struct Documentation
    • prism::PGC::utils::MultisampleSettings
      • sampleShadingEnable
      • rasterizationSamples
      • strategy

• Struct PipelineSettings
  • Struct Documentation
    • prism::PGC::utils::PipelineSettings
      • shaders
      • inputAssembly
      • rasterization
      • depthStencil
      • multisample
      • colorBlend
      • dynamicState
      • viewportState

• Struct QueueFamilyIndices
  • Struct Documentation
    • prism::PGC::utils::QueueFamilyIndices
      • isComplete()
      • graphicsFamily
      • presentFamily

• Struct RasterizationSettings
  • Struct Documentation
    • prism::PGC::utils::RasterizationSettings
      • polygonMode
      • lineWidth
      • cullMode
      • frontFace
      • depthClampEnable
      • rasterizerDiscardEnable
      • depthBiasEnable

• Struct Settings
  • Struct Documentation
    • prism::PGC::utils::Settings
      • app
      • deviceEvaluationWeights
      • debug
      • swapChain
      • descriptorSetLayout
      • textureDescriptorSetLayout
      • MAX_TEXTURES
      • pipeline
      • window

• Struct ShadersSettings
  • Struct Documentation
    • prism::PGC::utils::ShadersSettings
      • vertexShaderFilename
      • fragmentShaderFilename
      • shadersDirectory

• Struct SwapChainSettings
  • Struct Documentation
    • prism::PGC::utils::SwapChainSettings
      • enableVSync
      • enableTripleBuffering
      • preferredFormat

• Struct SwapChainSupportDetails
  • Struct Documentation
    • prism::PGC::utils::SwapChainSupportDetails
      • capabilities
      • formats
      • presentModes

• Struct TextureBindingConfig
  • Struct Documentation
    • prism::PGC::utils::TextureBindingConfig
      • binding
      • descriptorType
      • descriptorCount
      • stageFlags
      • immutableSamplers
      • bindingFlags

• Struct TextureDescriptorSetLayoutSettings
  • Struct Documentation
    • prism::PGC::utils::TextureDescriptorSetLayoutSettings
      • bindings
      • flags

• Struct ViewportStateSettings
  • Struct Documentation
    • prism::PGC::utils::ViewportStateSettings
      • viewportCount
      • scissorCount

• Struct Vertex
  • Struct Documentation
    • prism::PGC::Vertex
      • operator==()
      • pos
      • color
      • texCoord
      • getBindingDescription()
      • getAttributeDescriptions()

• Struct VertexHasher
  • Struct Documentation
    • prism::PGC::VertexHasher
      • operator()()

• Struct PrismInfo
  • Struct Documentation
    • prism::PrismInfo
      • NAME
      • DESCRIPTION

• Struct PrismVersion
  • Struct Documentation
    • prism::PrismVersion
      • MAJOR
      • MINOR
      • PATCH
      • STRING

• Struct CameraComponent
  • Struct Documentation
    • prism::scene::CameraComponent
      • isActive
      • look
      • fovy
      • aspect
      • zNear
      • zFar

• Template Struct ComponentManager::ComponentStorage
  • Nested Relationships
  • Inheritance Relationships
    • Base Type
  • Struct Documentation
    • prism::scene::ComponentManager::ComponentStorage
      • removeEntity()
      • components

• Struct ComponentManager::IComponentStorage
  • Nested Relationships
  • Struct Documentation
    • prism::scene::ComponentManager::IComponentStorage
      • ~IComponentStorage()
      • removeEntity()

• Struct Look
  • Struct Documentation
    • prism::scene::Look
      • x
      • y
      • z

• Struct MeshComponent
  • Struct Documentation
    • prism::scene::MeshComponent
      • mesh

• Struct Position
  • Struct Documentation
    • prism::scene::Position
      • x
      • y
      • z

• Struct Rotation
  • Struct Documentation
    • prism::scene::Rotation
      • x
      • y
      • z

• Struct Scale
  • Struct Documentation
    • prism::scene::Scale
      • x
      • y
      • z

• Struct TextureComponent
  • Struct Documentation
    • prism::scene::TextureComponent
      • texture

• Struct TransformComponent
  • Struct Documentation
    • prism::scene::TransformComponent
      • pos
      • rot
      • scale

• Struct Version
  • Struct Documentation
    • prism::Version
      • MAJOR
      • MINOR
      • PATCH

• Class Base
  • Class Documentation
    • prism::PGC::base::Base
      • Base()
      • init()
      • ~Base()
      • cleanup()

• Class BufferWrapper
  • Class Documentation
    • prism::PGC::BufferWrapper
      • createBuffer()
      • copyBuffer()
      • endSingleTimeCommands()
      • beginSingleTimeCommands()
      • transitionImageLayout()
      • copyBufferToImage()
      • createVertexBuffer()
      • createIndexBuffer()
      • createUniformBuffers()

• Class DescriptorSet
  • Class Documentation
    • prism::PGC::DescriptorSet
      • DescriptorSet()
      • init()
      • ~DescriptorSet()
      • cleanup()

• Class DescriptorSetLayout
  • Class Documentation
    • prism::PGC::DescriptorSetLayout
      • DescriptorSetLayout()
      • init()
      • ~DescriptorSetLayout()
      • cleanup()

• Class DeviceChecker
  • Class Documentation
    • prism::PGC::DeviceChecker
      • check()
      • checkBindless()
      • checkDeviceExtensionSupport()

• Class DeviceRater
  • Class Documentation
    • prism::PGC::DeviceRater
      • rate()

• Class DeviceWrapper
  • Class Documentation
    • prism::PGC::DeviceWrapper
      • getDeviceProperties()
      • getDeviceExtensionProperties()
      • getDeviceMemoryProperties()
      • findQueueFamilies()
      • querySwapChainSupport()
      • getDeviceFormatProperties()
      • findDepthFormat()
      • findMemoryType()
      • findSupportedFormat()

• Class GraphicsPipeline
  • Class Documentation
    • prism::PGC::GraphicsPipeline
      • GraphicsPipeline()
      • init()
      • ~GraphicsPipeline()
      • cleanup()

• Class MeshLoader
  • Class Documentation
    • prism::PGC::MeshLoader
      • load()

• Class MeshManager
  • Class Documentation
    • prism::PGC::MeshManager
      • addMesh()
      • update()
      • clear()
      • getMeshInfo()

• Class PrismGraphicCore
  • Class Documentation
    • prism::PGC::PrismGraphicCore
      • PrismGraphicCore()
      • init()
      • drawFrame()
      • startRender()
      • getCameraDataPtr()
      • getSwapChainPtr()
      • cleanup()
      • awaitRenderingCompletion()
      • isWindowReadyForRendering()
      • windowResized
      • windowMinimized
      • settings
      • context

• Class RenderPass
  • Class Documentation
    • prism::PGC::RenderPass
      • RenderPass()
      • init()
      • ~RenderPass()
      • cleanup()

• Class ResourcesCreater
  • Class Documentation
    • prism::PGC::ResourcesCreater
      • createImage()
      • createImageView()
      • createFramebuffers()
      • createColorResources()
      • createDepthResources()
      • createTextureSampler()

• Class ScoreWrapper
  • Class Documentation
    • prism::PGC::ScoreWrapper
      • print()
      • print()
      • print()
      • getTotal()
      • getTotal()
      • getTotal()

• Class ShaderStagesLoader
  • Class Documentation
    • prism::PGC::ShaderStagesLoader
      • load()

• Class SwapChain
  • Class Documentation
    • prism::PGC::SwapChain
      • SwapChain()
      • init()
      • ~SwapChain()
      • cleanup()
      • awaitRenderingCompletion()
      • recreate()

• Class TextureLoader
  • Class Documentation
    • prism::PGC::TextureLoader
      • load()
      • cleanup()

• Class TextureManager
  • Class Documentation
    • prism::PGC::TextureManager
      • addTexture()
      • removeTexture()
      • cleanup()
      • updateDescriptors()

• Class Renderer
  • Class Documentation
    • prism::render::Renderer
      • Renderer()
      • linkWindow()
      • setDefaultSettings()
      • init()
      • ~Renderer()
      • isRenderingActive()
      • beginFrame()
      • beginRender()
      • endRender()
      • endFrame()
      • updateCamera()
      • updateObjectTransform()
      • bindDefault()
      • bindTransform()
      • pushTextureId()
      • drawMesh()
      • addTexture()
      • removeTexture()
      • addMesh()
      • updateMeshes()
      • clearMeshes()
      • awaitRenderingCompletion()
      • destroy()
      • settings

• Class Window
  • Class Documentation
    • prism::render::Window
      • Window()
      • operator=()
      • Window()
      • operator=()
      • Window()
      • Window()
      • Window()
      • Window()
      • Window()
      • ~Window()
      • getTitle()
      • setTitle()
      • getWidth()
      • getHeight()
      • getSize()
      • setWidth()
      • setHeight()
      • setSize()
      • setFullscreen()
      • setBorderless()
      • setResizable()
      • setGrabMouse()
      • isFullscreen()
      • isBorderless()
      • isResizable()
      • isGrabMouse()
      • setPosition()
      • getPosition()
      • centerWindow()
      • setMinSize()
      • setMaxSize()
      • shouldClose()
      • setCloseRequested()
      • handleEvents()
      • clear()
      • update()
      • destroy()
      • sdlWindow
      • windowResized
      • windowMinimized
      • CreateCentered()
      • setSDLInitialized()

• Class ComponentManager
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • prism::scene::ComponentManager
      • ComponentManager()
      • addComponent()
      • removeComponent()
      • getComponent()
      • getEntitiesWith()
      • getEntitiesWith()
      • getEntitiesWithAll()
      • removeAllComponents()

• Class EntityManager
  • Class Documentation
    • prism::scene::EntityManager
      • EntityManager()
      • createEntity()
      • destroyEntity()
      • isEntityValid()

• Class ISystem
  • Inheritance Relationships
    • Derived Type
  • Class Documentation
    • prism::scene::ISystem
      • ~ISystem()
      • update()
      • enabled

• Class RenderSystem
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • prism::scene::RenderSystem
      • RenderSystem()
      • update()

• Class Scene
  • Class Documentation
    • prism::scene::Scene
      • Scene()
      • createEntity()
      • destroyEntity()
      • enableSystem()
      • disableSystem()
      • update()
      • addComponent()
      • removeComponent()
      • getComponent()
      • getEntitiesWith()
      • getEntitiesWithAll()
      • registerSystem()

• Class SystemManager
  • Class Documentation
    • prism::scene::SystemManager
      • SystemManager()
      • registerSystem()
      • enableSystem()
      • disableSystem()
      • update()

Enums

• Enum Error
  • Enum Documentation
    • Error
      • TEST_ERROR
      • FAILED_TO_CREATE_VK_INSTANCE
      • FAILED_TO_CREATE_WINDOW_SURFACE
      • PRISM_ENGINE_NOT_INITIALIZE
      • WINDOW_INSTANCE_CREATE_ERROR
      • NOT_CALL_CLEANUP_IN_PGC_CORE
      • SDL_VULKAN_EXTENSIONS_COUNT_FAILED
      • VULKAN_VALIDATION_LAYERS_UNAVAILABLE
      • VULKAN_DEBUG_MESSENGER_SETUP_FAILED
      • VULKAN_NO_GPU_SUPPORT
      • VULKAN_NO_SUITABLE_GPU
      • VULKAN_LOGICAL_DEVICE_CREATION_FAILED
      • VULKAN_SWAP_CHAIN_FAILED
      • FAILED_TO_OPEN_FILE
      • FAILED_TO_DETERMINE_FILE_SIZE
      • FAILED_TO_READ_FILE

• Enum Level
  • Enum Documentation
    • Level
      • VERBOSE
      • DEBUG
      • INFO
      • WARNING
      • ERROR
      • CRITICAL

• Enum MultisampleSelectionStrategy
  • Enum Documentation
    • MultisampleSelectionStrategy
      • MINIMAL
      • MIDDLE
      • MAXIMAL
      • CUSTOM

Functions

• Function prism::init
  • Function Documentation
    • init()

• Function prism::logger::checkLastErrorType
  • Function Documentation
    • checkLastErrorType()

• Function prism::logger::clearLastError
  • Function Documentation
    • clearLastError()

• Function prism::logger::critical
  • Function Documentation
    • critical()

• Function prism::logger::debug
  • Function Documentation
    • debug()

• Function prism::logger::error
  • Function Documentation
    • error()

• Function prism::logger::getLastError
  • Function Documentation
    • getLastError()

• Function prism::logger::hasLastError
  • Function Documentation
    • hasLastError()

• Function prism::logger::info
  • Function Documentation
    • info()

• Function prism::logger::log
  • Function Documentation
    • log()

• Function prism::logger::logError
  • Function Documentation
    • logError()

• Function prism::logger::setLevel
  • Function Documentation
    • setLevel()

• Function prism::logger::setOutputConsole
  • Function Documentation
    • setOutputConsole()

• Function prism::logger::setOutputFile
  • Function Documentation
    • setOutputFile()

• Function prism::logger::verbose
  • Function Documentation
    • verbose()

• Function prism::logger::warning
  • Function Documentation
    • warning()

• Function prism::math::degToRad
  • Function Documentation
    • degToRad()

• Function prism::math::Matrix_MultiplyMatrix
  • Function Documentation
    • Matrix_MultiplyMatrix()

• Function prism::math::Matrix_QuickInverse
  • Function Documentation
    • Matrix_QuickInverse()

• Function prism::math::Vector_CrossProduct
  • Function Documentation
    • Vector_CrossProduct()

• Function prism::math::Vector_DotProduct
  • Function Documentation
    • Vector_DotProduct()

• Function prism::math::Vector_IntersectPlane
  • Function Documentation
    • Vector_IntersectPlane()

• Function prism::PGC::CreateDebugUtilsMessengerEXT
  • Function Documentation
    • CreateDebugUtilsMessengerEXT()

• Function prism::PGC::DestroyDebugUtilsMessengerEXT
  • Function Documentation
    • DestroyDebugUtilsMessengerEXT()

Variables

• Variable prism::INVALID_TEXTURE
  • Variable Documentation
    • INVALID_TEXTURE

• Variable prism::isInit
  • Variable Documentation
    • isInit

• Variable prism::scene::INVALID_COMPONENT_TYPE
  • Variable Documentation
    • INVALID_COMPONENT_TYPE

• Variable prism::scene::INVALID_ENTITY_ID
  • Variable Documentation
    • INVALID_ENTITY_ID

• Variable prism::scene::INVALID_SYSTEM_ID
  • Variable Documentation
    • INVALID_SYSTEM_ID

Defines

• Define GLM_FORCE_DEPTH_ZERO_TO_ONE
  • Define Documentation
    • GLM_FORCE_DEPTH_ZERO_TO_ONE

• Define GLM_FORCE_RADIANS
  • Define Documentation
    • GLM_FORCE_RADIANS

• Define M_E
  • Define Documentation
    • M_E

• Define M_PI
  • Define Documentation
    • M_PI

• Define STB_IMAGE_IMPLEMENTATION
  • Define Documentation

• Define TINYOBJLOADER_IMPLEMENTATION
  • Define Documentation

Typedefs

• Typedef prism::Mesh
  • Typedef Documentation
    • Mesh

• Typedef prism::scene::ComponentType
  • Typedef Documentation
    • ComponentType

• Typedef prism::scene::Entity
  • Typedef Documentation
    • Entity

• Typedef prism::scene::SystemId
  • Typedef Documentation
    • SystemId

• Typedef prism::Texture
  • Typedef Documentation
    • Texture