Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Portal Framework
Light Logo Dark Logo
  • Introduction
    • Architecture
    • Features ⚠️
  • Getting Started
    • Installation
    • Quickstart
    • Advanced Project Setup ⚠️
  • Tutorials ⚠️
    • Tutorial 1: Window and Inputs ⚠️
    • Tutorial 2: Rendering Basics ⚠️
    • Tutorial 3: Scene Graph ⚠️
    • Tutorial 4: Materials and Shaders ⚠️
    • Tutorial 5: Building A Simple Game ⚠️
  • How-To Guides ⚠️
    • Offscreen Rendering ⚠️
    • Resize Handling ⚠️
    • Load textures ⚠️
    • Load Models ⚠️
    • Load Scenes ⚠️
    • Load from GLTF file ⚠️
    • Archive to JSON ⚠️
    • Binary Serialization ⚠️
    • Serialize Custom Objects ⚠️
    • Add a new system ⚠️
  • Concepts
    • Engine Architecture ⚠️
    • Frame Lifecycle ⚠️
    • Job System
    • Resource Management
    • Buildsystem ⚠️
  • Modules ⚠️
    • Core Module ⚠️
    • Application Module ⚠️
    • Input Module ⚠️
    • Engine Module ⚠️
    • Serialization Module ⚠️
    • Networking Module ⚠️
  • API Reference
    • Portal Core Api
      • Namespace fmt
      • Namespace llvm
      • Namespace portal
      • Namespace portal::details
      • Namespace portal::hash
      • Namespace portal::jobs
      • Namespace portal::platform
      • Namespace portal::reflection
      • Namespace spdlog
      • Namespace std
      • Namespace std::string_view_literals
      • Template Struct formatter< glm::mat2 >
      • Template Struct formatter< glm::mat3 >
      • Template Struct formatter< glm::mat4 >
      • Template Struct formatter< glm::vec2 >
      • Template Struct formatter< glm::vec3 >
      • Template Struct formatter< glm::vec4 >
      • Template Struct formatter< portal::reflection::Property >
      • Template Struct formatter< portal::StringId >
      • Template Struct formatter< portal::uint128_t >
      • Template Struct formatter< T >
      • Template Struct DenseMapInfo< portal::StringId >
      • Struct BasicCoroutine::Promise
      • Struct Buffer
      • Template Struct concat
      • Template Struct concat< type_list< Ts… > >
      • Template Struct concat< type_list< Ts… >, type_list< Us… >, Rest… >
      • Template Struct concat< >
      • Template Struct visitor
      • Struct FileStat
      • Struct FileSystem::FileDialogFilterItem
      • Template Struct filter
      • Template Struct filter< Pred >
      • Template Struct filter< Pred, T, Ts… >
      • Template Struct FlagTraits
      • Template Struct is_specialization_of
      • Template Struct is_specialization_of< Template< Args… >, Template >
      • Struct Counter
      • Struct Scheduler::WorkerContext
      • Struct JobStats::GlobalStats
      • Struct JobStats::ThreadStats
      • Struct Log::LoggerSettings
      • Struct PerformanceProfiler::PerFrameData
      • Template Struct QueueSet
      • Struct Property
      • Struct StringId
      • Struct SwitchInformation
      • Struct Task::Awaiter
      • Struct Task::FinalAwaiter
      • Struct Task::Promise
      • Struct ThreadSpecification
      • Template Struct type_list
      • Struct uint128_t
      • Template Struct hash< portal::StringId >
      • Template Struct hash< portal::uint128_t >
      • Class AssertionLock
      • Class BasicCoroutine
      • Template Class BucketPoolAllocator
      • Template Class BufferedAllocator
      • Class BufferStreamReader
      • Class BufferStreamWriter
      • Class FileSystem
      • Class FinalizeJob
      • Template Class Flags
      • Class FreeCoTaskMemory
      • Template Class Job
      • Template Class Job< void >
      • Class JobBase
      • Class JobPromise
      • Class JobPromise::JobAwaiter
      • Class Scheduler
      • Class JobStats
      • Class LinuxThread
      • Class Log
      • Class MacOSThread
      • Class MesmerTwistedRandom
      • Class PerformanceProfiler
      • Template Class PoolAllocator
      • Class Random
      • Template Class ReentrantSpinLock
      • Template Class ResultPromise
      • Template Class ResultPromise< void >
      • Class ScopedLogContext
      • Class ScopedPerformanceTimer
      • Template Class ScopedTimer
      • Class source_location_flag_formatter
      • Class SpinLock
      • Class StackAllocator
      • Class StringRegistry
      • Class SuspendJob
      • Template Class Task
      • Class ThreadBase
      • Class Timer
      • Class WindowsThread
      • Class WorkerQueue
      • Enum Encoding
      • Enum FileStatus
      • Enum JobPriority
      • Enum JobResultStatus
      • Enum WorkerIterationState
      • Enum PropertyContainerType
      • Enum PropertyType
      • Enum SwitchType
      • Enum ThreadAffinity
      • Enum ThreadPriority
      • Template Function add_overflow_impl
      • Template Function operator&(BitType, const portal::Flags<BitType>&)
      • Template Function operator&(BitType, BitType)
      • Template Function operator^(BitType, const portal::Flags<BitType>&)
      • Template Function operator^(BitType, BitType)
      • Template Function operator|(BitType, const portal::Flags<BitType>&)
      • Template Function operator|(BitType, BitType)
      • Template Function operator~
      • Function portal::add_to_platform_folders_form_file
      • Function portal::details::to_wstring
      • Template Function portal::details::visitor
      • Template Function portal::execute
      • Template Function portal::from_string
      • Function portal::get_appdata
      • Function portal::get_appdata_local
      • Function portal::get_bundle
      • Function portal::get_home()
      • Function portal::get_home()
      • Function portal::get_known_windows_folder
      • Function portal::get_last_part
      • Function portal::get_linux_folder_default
      • Function portal::get_platform_folders
      • Function portal::hash::rapidhash(const char *, const size_t)
      • Function portal::hash::rapidhash(const std::string_view)
      • Function portal::hash::rapidhash(const std::string&)
      • Function portal::hash::rapidhash(const char *)
      • Template Function portal::hash::rapidhash(const char(&))
      • Template Function portal::match
      • Function portal::platform::get_platform_sinks
      • Function portal::platform::print_assert_dialog
      • Function portal::reflection::get_float_type
      • Function portal::reflection::get_integer_type
      • Function portal::reflection::get_property_size
      • Template Function portal::reflection::get_property_type
      • Function portal::throw_on_relative
      • Function portal::to_lower
      • Function portal::to_lower_copy
      • Template Function portal::to_string
      • Function portal::utf16_to_utf8
      • Function PORTAL_DEBUG_BREAK_HELPER
      • Function rapid_mix
      • Function rapid_mum
      • Function rapid_read32
      • Function rapid_read64
      • Function rapidhash
      • Function rapidhash_internal
      • Function rapidhash_withSeed
      • Function rapidhashMicro
      • Function rapidhashMicro_internal
      • Function rapidhashMicro_withSeed
      • Function rapidhashNano
      • Function rapidhashNano_internal
      • Function rapidhashNano_withSeed
      • Template Function sub_overflow_impl
      • Variable portal::BUCKET_SIZE
      • Variable portal::default_pattern
      • Variable portal::DEFAULT_SIZE
      • Variable portal::g_job_promise_allocator
      • Variable portal::g_job_result_allocator
      • Variable portal::g_settings
      • Variable portal::INVALID_STRING_ID
      • Variable portal::INVALID_STRING_VIEW
      • Variable portal::is_specialization_of_v
      • Variable portal::JOB_POOL_SIZE
      • Variable portal::jobs::logger
      • Variable portal::logger
      • Variable portal::logger
      • Variable portal::logger
      • Variable portal::logger
      • Variable portal::MAX_STRING_ID
      • Variable portal::s_bundle_instance
      • Variable rapid_secret
      • Define _likely_
      • Define _unlikely_
      • Define add_overflow
      • Define ASSERT_LOCK
      • Define ASSERT_LOCK_GUARD
      • Define ASSERT_UNLOCK
      • Define COMPILED_PLATFORM_HEADER
      • Define ENABLE_JOB_STATS
      • Define LOG_DEBUG
      • Define LOG_DEBUG_TAG
      • Define LOG_ERROR
      • Define LOG_ERROR_TAG
      • Define LOG_FATAL
      • Define LOG_FATAL_TAG
      • Define LOG_INFO
      • Define LOG_INFO_TAG
      • Define LOG_TRACE
      • Define LOG_TRACE_TAG
      • Define LOG_WARN
      • Define LOG_WARN_TAG
      • Define LOGGER_DEBUG
      • Define LOGGER_ERROR
      • Define LOGGER_FATAL
      • Define LOGGER_INFO
      • Define LOGGER_TRACE
      • Define LOGGER_WARN
      • Define PORTAL_ASSERT
      • Define PORTAL_ASSERT_MESSAGE_BOX
      • Define PORTAL_ASSERT_MESSAGE_INTERNAL
      • Define PORTAL_DEBUG_BREAK
      • Define PORTAL_ENABLE_ASSERTS
      • Define PORTAL_EXPLICIT_STATIC
      • Define PORTAL_FORCE_INLINE
      • Define PORTAL_FRAME_MARK
      • Define PORTAL_FRAME_MARK_END
      • Define PORTAL_FRAME_MARK_START
      • Define PORTAL_HAS_CONSOLE
      • Define PORTAL_HAS_CONSOLE
      • Define PORTAL_HASH_CONSTEXPR
      • Define PORTAL_JOIN
      • Define PORTAL_NAME_THREAD
      • Define PORTAL_PRIVATE_JOIN
      • Define PORTAL_PRIVATE_STRINGIZE
      • Define PORTAL_PROF_LOCK
      • Define PORTAL_PROF_ZONE
      • Define PORTAL_STRINGIZE
      • Define PORTAL_TRACE_ALLOC
      • Define PORTAL_TRACE_FREE
      • Define PORTAL_TRACE_REALLOC
      • Define RAPIDHASH_ALWAYS_INLINE
      • Define RAPIDHASH_COMPACT
      • Define RAPIDHASH_CONSTEXPR
      • Define RAPIDHASH_FAST
      • Define RAPIDHASH_INLINE
      • Define RAPIDHASH_INLINE_CONSTEXPR
      • Define RAPIDHASH_LITTLE_ENDIAN
      • Define RAPIDHASH_NOEXCEPT
      • Define SCOPED_TIMER
      • Define SOURCE_LOC
      • Define STRING_ID
      • Define sub_overflow
      • Typedef portal::concat_t
      • Typedef portal::DoubleBufferedAllocator
      • Typedef portal::filter_t
      • Typedef portal::Thread
    • Portal Application Api
      • Namespace portal
      • Namespace portal::ecs
      • Struct ApplicationProperties
      • Template Struct FlagTraits< ModuleTags >
      • Struct FrameContext
      • Struct FrameStats
      • Class Application
      • Class BaseModule
      • Template Class ModuleLookup
      • Class ModuleStack
      • Class ProjectSettings
      • Template Class Tag
      • Template Class TaggedModule
      • Enum ModuleTags
      • Enum SettingsArchiveType
      • Function main
      • Function portal::create_application
      • Function portal::main
      • Variable portal::LOG_LEVEL_ENTRY
      • Variable portal::logger
      • Variable portal::PORTAL_SETTINGS_FILE_NAME
      • Typedef portal::Module
      • Typedef portal::TagFlag
    • Portal Input Api
      • Namespace portal
      • Template Struct FlagTraits< KeyModifierBits >
      • Struct KeyData
      • Struct KeyPressedEvent
      • Struct KeyReleasedEvent
      • Struct KeyRepeatEvent
      • Struct MouseMovedEvent
      • Struct MouseScrolledEvent
      • Struct ReportAnalogAxisEvent
      • Struct ReportKeyActionEvent
      • Struct SetMouseCursorEvent
      • Class InputManager
      • Enum Axis
      • Enum CursorMode
      • Enum Key
      • Enum KeyModifierBits
      • Enum KeyState
      • Variable portal::logger
      • Typedef portal::KeyModifierFlag
    • Portal Serialization Api
      • Namespace portal
      • Template Struct Archivable
      • Struct BinarySerializationParams
      • Struct Header
      • Template Struct Serializable
      • Class ArchiveObject
      • Class BinaryDeserializer
      • Class BinarySerializer
      • Class Deserializer
      • Class JsonArchive
      • Template Class ReservedSlot
      • Class Serializer
      • Template Function operator<<(portal::Serializer&, const T&)
      • Template Function operator<<(portal::Serializer&, T&)
      • Template Function operator<<(portal::Serializer&, const T&)
      • Function operator<<(portal::Serializer&, const char *)
      • Template Function operator<<(portal::Serializer *, const T&)
      • Template Function operator>>(portal::Deserializer&, T&)
      • Template Function operator>>(portal::Deserializer&, T&)
      • Function portal::element_number_size
      • Function portal::get_size
      • Function portal::should_encode_element_number
      • Variable portal::MAGIC
      • Variable portal::VERSION
    • Portal Engine Api
      • Namespace fastgltf
      • Namespace fmt
      • Namespace ImGui
      • Namespace portal
      • Namespace portal::@11
      • Namespace portal::@13
      • Namespace portal::@2
      • Namespace portal::@37
      • Namespace portal::@4
      • Namespace portal::@47
      • Namespace portal::@6
      • Namespace portal::@8
      • Namespace portal::content_browser
      • Namespace portal::ecs
      • Namespace portal::ecs::@9
      • Namespace portal::ecs::details
      • Namespace portal::imgui
      • Namespace portal::jobs
      • Namespace portal::renderer
      • Namespace portal::renderer::image
      • Namespace portal::renderer::shader_reflection
      • Namespace portal::renderer::utils
      • Namespace portal::renderer::vulkan
      • Namespace portal::renderer::vulkan::@161
      • Namespace portal::renderer::vulkan::allocation
      • Namespace portal::renderer::vulkan::utils
      • Namespace portal::resources
      • Namespace portal::resources::utils
      • Namespace portal::scene
      • Namespace portal::utils
      • Namespace shader_reflection
      • Namespace std
      • Namespace std::literals
      • Template Struct formatter< portal::Entity >
      • Template Struct formatter< portal::ResourceReference< T > >
      • Template Struct formatter< portal::TransformComponent >
      • Template Struct Archivable< ImGuiStyle >
      • Template Struct Archivable< ImVec2 >
      • Template Struct Archivable< ImVec4 >
      • Struct CameraComponent
      • Template Struct ComponentEditorFunctions
      • Template Struct ComponentEditorFunctions< CameraComponent >
      • Template Struct ComponentEditorFunctions< DirectionalLightComponent >
      • Template Struct ComponentEditorFunctions< StaticMeshComponent >
      • Template Struct ComponentEditorFunctions< TransformComponent >
      • Struct CompositeMetadata
      • Struct DirectoryInfo
      • Struct ContentBrowserConsts
      • Struct DatabaseDescription
      • Struct DatabaseMetadata
      • Struct DirectionalLightComponent
      • Struct DrawEntityNodeConsts
      • Template Struct Owns
      • Template Struct System::group_caller
      • Template Struct System::group_caller< type_list< Owned… >, type_list< Viewed… > >
      • Template Struct System::is_owns_wrapper
      • Template Struct System::is_views_wrapper
      • Template Struct Views
      • Struct EditorContext
      • Struct EditorIcons::image_data
      • Struct EmptyMeta
      • Template Struct FlagTraits< portal::content_browser::ActionBit >
      • Template Struct FlagTraits< portal::imgui::VectorAxisBits >
      • Template Struct FlagTraits< portal::renderer::SurfaceTransformBits >
      • Template Struct FlagTraits< ResourceDirtyBits >
      • Struct FontMetadata
      • Struct FontProperties
      • Struct EditVec3Consts
      • Struct PropertyResourceReferenceSettings
      • Struct ScopedButtonRepeat
      • Struct ScopedChild
      • Struct ScopedChildFrame
      • Struct ScopedClipRect
      • Struct ScopedColor
      • Struct ScopedCombo
      • Struct ScopedDragDropSource
      • Struct ScopedDragDropTarget
      • Struct ScopedFont
      • Struct ScopedGroup
      • Struct ScopedID
      • Struct ScopedItemWidth
      • Struct ScopedMainMenuBar
      • Struct ScopedMenu
      • Struct ScopedMenuBar
      • Struct ScopedPopup
      • Struct ScopedPopupContextItem
      • Struct ScopedPopupContextVoid
      • Struct ScopedPopupContextWindow
      • Struct ScopedPopupModal
      • Struct ScopedRectangleMenuBar
      • Struct ScopedStyle
      • Struct ScopedTextWrapPos
      • Struct ScopedTooltip
      • Struct ScopedTreeNode
      • Struct ScopedTreeNodeEx
      • Struct ScopedTreeNodeExV
      • Struct ScopedTreeNodeIcon
      • Struct ScopedTreeNodeIcon::TreeNodeConsts
      • Struct ScopedTreeNodeV
      • Struct ScopedWindow
      • Struct SearchWidgetConsts
      • Struct ImGuiFontConfiguration
      • Struct MainCameraTag
      • Struct MaterialMetadata
      • Struct NameComponent
      • Struct PanelData
      • Struct PlayerTag
      • Struct PointLightComponent
      • Struct ProjectProperties
      • Struct RelationshipComponent
      • Struct AttachmentProperties
      • Struct AttachmentTextureProperty
      • Struct Capabilities
      • Struct CompiledShader
      • Struct DescriptorInput
      • Struct DescriptorSetManagerProperties
      • Struct DriverVersion
      • Struct FrameRenderingContext
      • Struct FrameResources
      • Struct ClearValue
      • Struct Properties
      • Struct SubresourceRange
      • Struct ImageViewProperties
      • Struct MaterialProperties
      • Struct PipelineProperties
      • Struct PipelineStatistics
      • Struct RenderObject
      • Struct RenderTargetProperties
      • Struct SamplerProperties
      • Struct BufferDescriptor
      • Struct ImageSamplerDescriptor
      • Struct PushConstantsRange
      • Struct ReflectedStruct
      • Struct ShaderDescriptorSet
      • Struct ShaderResourceDeclaration
      • Struct StageInfo
      • Struct StructField
      • Struct Uniform
      • Struct ShaderCompiler::CompileRequest
      • Struct ShaderDefine
      • Struct ShaderReflection
      • Struct ShaderStaticConstants
      • Struct StorageBufferProperties
      • Struct SurfaceCapabilities
      • Struct SurfaceProperties
      • Struct TextureProperties
      • Struct Bounds
      • Struct BufferBuilder
      • Struct DescriptorAllocator::PoolSizeRatio
      • Struct DescriptorWriter
      • Struct GPUDirectionalLight
      • Struct GPUDrawPushConstants
      • Struct GPUMeshBuffers
      • Struct GPUPointLight
      • Struct GPUSceneCamera
      • Struct GPUSceneData
      • Struct GPUSceneDirectionLight
      • Struct GPUSceneLights
      • Struct GPUScenePointLights
      • Struct GPUSceneSpotLights
      • Struct GPUScreenData
      • Struct GPUSpotLight
      • Struct ImageBuilder
      • Struct SwapchainImageData
      • Struct VulkanDescriptorSetManager::WriteDescriptor
      • Struct VulkanDevice::ImmediateCommandBuffer
      • Struct VulkanImageInfo
      • Struct VulkanMaterial::UniformPointer
      • Struct VulkanPhysicalDevice::QueueFamilyIndices
      • Struct Bounds
      • Struct DatabaseEntry
      • Struct FacadeDatabaseEntry
      • Struct FolderDatabaseEntry
      • Struct MaterialDetails
      • Struct MeshData
      • Struct MeshGeometryData
      • Struct MeshGeometryData::Submesh
      • Struct ResourceData
      • Struct Vertex
      • Struct SceneContext
      • Struct SceneGraphConsts
      • Struct SceneTag
      • Struct SelectionComponent
      • Struct SkylightComponent
      • Struct SnapshotManager::SnapshotData
      • Struct SnapshotManager::SnapshotView
      • Struct SourceMetadata
      • Struct SpotlightComponent
      • Struct StaticMeshComponent
      • Struct TextureMetadata
      • Struct TopbarConsts
      • Struct TransformDirtyTag
      • Struct WindowClosedEvent
      • Struct WindowDragEvent
      • Struct WindowExtent
      • Struct WindowFocusEvent
      • Struct WindowProperties
      • Struct WindowRequestCloseEvent
      • Struct WindowRequestMaximizeOrRestoreEvent
      • Struct WindowRequestMinimizeEvent
      • Struct WindowResizeEvent
      • Struct WindowTitleConsts
      • Struct WindowUpdateMaximizedEvent
      • Template Struct hash< portal::ResourceType >
      • Class BaseCameraController
      • Class BaseCameraSystem
      • Class BasePlayerInputSystem
      • Class ChildIterator
      • Class ChildRange
      • Class Composite
      • Class DirectoryItem
      • Class Item
      • Class ItemList
      • Class ResourceItem
      • Class SelectionStack
      • Class ContentBrowserPanel
      • Class DeletionQueue
      • Class DetailsPanel
      • Class Registry
      • Template Class System
      • Class SystemBase
      • Class EditorIcons
      • Class EditorModule
      • Class Engine
      • Class EngineContext
      • Class Entity
      • Class FolderResourceDatabase
      • Class Font
      • Class GlfwWindow
      • Class EditorTheme
      • Class ImGuiFonts
      • Class ImGuiRenderer
      • Class InputRouter
      • Class MeshGeometry
      • Class Panel
      • Class PanelManager
      • Class Project
      • Class RecursiveChildIterator
      • Class RecursiveChildRange
      • Class ReferenceManager
      • Class Renderer
      • Class BaseDescriptor
      • Class BufferDescriptor
      • Class DescriptorSetManager
      • Class Device
      • Class Image
      • Class ImageView
      • Class Material
      • Class PhysicalDevice
      • Class Pipeline
      • Class Queue
      • Class RenderTarget
      • Class Sampler
      • Class Shader
      • Class ShaderCompiler
      • Class ShaderVariant
      • Class StorageBuffer
      • Class StorageBufferSet
      • Class Surface
      • Class Texture
      • Class UniformBuffer
      • Class UniformBufferSet
      • Class AllocatedBuffer
      • Template Class Allocated
      • Template Class BuilderBase
      • Class DebugMessenger
      • Class DescriptorAllocator
      • Class DescriptorLayoutBuilder
      • Class ImageAllocation
      • Class PipelineBuilder
      • Class VulkanContext
      • Class VulkanDescriptorSetManager
      • Class VulkanDevice
      • Class VulkanImage
      • Class VulkanImageView
      • Class VulkanInstance
      • Class VulkanMaterial
      • Class VulkanPhysicalDevice
      • Class VulkanPipeline
      • Class VulkanQueue
      • Class VulkanRenderTarget
      • Template Class VulkanResource
      • Class VulkanSampler
      • Class VulkanShader
      • Class VulkanShaderVariant
      • Class VulkanStorageBuffer
      • Class VulkanStorageBufferSet
      • Class VulkanSurface
      • Class VulkanSwapchain
      • Class VulkanTexture
      • Class VulkanUniformBuffer
      • Class VulkanUniformBufferSet
      • Class RendererContext
      • Class Resource
      • Class ResourceDatabase
      • Class ResourceDatabaseFacade
      • Class ResourceDatabaseFactory
      • Template Class ResourceReference
      • Class ResourceRegistry
      • Class FileSource
      • Class FontLoader
      • Class GltfLoader
      • Class LoaderFactory
      • Class MaterialLoader
      • Class MemorySource
      • Class MeshLoader
      • Class ResourceLoader
      • Class ResourceSource
      • Class SceneLoader
      • Class ShaderLoader
      • Class StubLoader
      • Class TextureLoader
      • Class ResourcesModule
      • Class RuntimeModule
      • Class Scene
      • Class SceneGraphPanel
      • Class SceneRenderingSystem
      • Class SchedulerModule
      • Class SelectionSystem
      • Class SnapshotManager
      • Class StatisticsPanel
      • Class SystemOrchestrator
      • Class TransformComponent
      • Class TransformHierarchySystem
      • Class Viewport
      • Class Window
      • Class WindowTitlebar
      • Enum ActionBit
      • Enum DatabaseErrorBit
      • Enum DatabaseType
      • Enum ExecutionPolicy
      • Enum EditorIcon
      • Enum OutlineFlags_
      • Enum ResourceReferenceErrors
      • Enum ThemeColors
      • Enum VectorAxisBits
      • Enum LightType
      • Enum PanelMenuCategory
      • Enum ProjectionType
      • Enum ProjectType
      • Enum AttachmentLoadOperator
      • Enum BlendMode
      • Enum DepthCompareOperator
      • Enum DescriptorResourceType
      • Enum DescriptorType
      • Enum Flags
      • Enum ImageFormat
      • Enum ImageUsage
      • Enum PipelineStage
      • Enum PrimitiveTopology
      • Enum ResourceAccessFlags
      • Enum SamplerMipmapMode
      • Enum ShaderStage
      • Enum SurfaceTransformBits
      • Enum SurfaceType
      • Enum TextureFilter
      • Enum TextureType
      • Enum TextureWrap
      • Enum ResourceDirtyBits
      • Enum MaterialPass
      • Enum ResourceState
      • Enum ResourceType
      • Enum SourceFormat
      • Enum WindowMode
      • Function portal::create_application
      • Function portal::create_engine_application
      • Function portal::draw_vec3_control
      • Template Function portal::ecs::archive_component
      • Template Function portal::ecs::dearchive_component
      • Template Function portal::ecs::deserialize_component
      • Template Function portal::ecs::find_dependencies
      • Template Function portal::ecs::post_serialization_pass
      • Template Function portal::ecs::print
      • Template Function portal::ecs::register_component
      • Template Function portal::ecs::serialize_component
      • Function portal::find_database_prefix
      • Function portal::from_project
      • Function portal::glfw_cursor_pos_callback
      • Function portal::glfw_error_callback
      • Function portal::glfw_key_callback
      • Function portal::glfw_mouse_button_callback
      • Function portal::glfw_on_maximized_callback
      • Function portal::glfw_scroll_callback
      • Function portal::glfw_window_close_callback
      • Function portal::glfw_window_focus_callback
      • Function portal::glfw_window_resize_callback
      • Function portal::imgui::begin_menu_with_image
      • Function portal::imgui::begin_property
      • Function portal::imgui::begin_property_grid
      • Function portal::imgui::color_with_multiplied_saturation
      • Function portal::imgui::color_with_multiplied_value
      • Template Function portal::imgui::confirm_and_execute
      • Function portal::imgui::draw_border
      • Function portal::imgui::draw_button_image(const vk::DescriptorSet, const ImColor, const ImColor, const ImColor, const ImVec2, const ImVec2, const ImVec2)
      • Function portal::imgui::draw_button_image(const vk::DescriptorSet, const ImColor, const ImColor, const ImColor, const ImRect, const ImVec2, const ImVec2)
      • Function portal::imgui::draw_button_image(const vk::DescriptorSet, const ImColor, const ImColor, const ImColor, const ImVec2, const ImVec2, const ImVec2, const ImVec2)
      • Function portal::imgui::draw_button_image(const vk::DescriptorSet, const vk::DescriptorSet, const vk::DescriptorSet, const ImColor, const ImColor, const ImColor, const ImVec2, const ImVec2, const ImVec2, const ImVec2)
      • Template Function portal::imgui::draw_consts_controls
      • Function portal::imgui::draw_item_activity_outline
      • Function portal::imgui::edit_vec3
      • Function portal::imgui::end_property
      • Function portal::imgui::end_property_grid
      • Function portal::imgui::expand_rect(const ImRect&, const float)
      • Function portal::imgui::expand_rect(const ImRect&, const float, const float)
      • Function portal::imgui::generate_id
      • Function portal::imgui::generate_label_id
      • Function portal::imgui::get_item_rect
      • Function portal::imgui::help_marker
      • Function portal::imgui::is_item_disabled
      • Function portal::imgui::is_item_hovered
      • Function portal::imgui::is_matching_search
      • Function portal::imgui::menu_item_icon_padding
      • Function portal::imgui::menu_item_with_image
      • Function portal::imgui::navigated_to
      • Function portal::imgui::options_button
      • Function portal::imgui::pop_id
      • Function portal::imgui::property(std::string_view, std::string&, const std::string_view)
      • Function portal::imgui::property(std::string_view, const std::string&, const std::string_view)
      • Function portal::imgui::Property
      • Function portal::imgui::property(std::string_view, bool&, std::string_view)
      • Function portal::imgui::property(std::string_view, int8_t&, int8_t, int8_t, std::string_view)
      • Function portal::imgui::property(std::string_view, int16_t&, int16_t, int16_t, std::string_view)
      • Function portal::imgui::property(std::string_view, int32_t&, int32_t, int32_t, std::string_view)
      • Function portal::imgui::property(std::string_view, int64_t&, int64_t, int64_t, std::string_view)
      • Function portal::imgui::property(std::string_view, uint8_t&, uint8_t, uint8_t, std::string_view)
      • Function portal::imgui::property(std::string_view, uint16_t&, uint16_t, uint16_t, std::string_view)
      • Function portal::imgui::property(std::string_view, uint32_t&, uint32_t, uint32_t, std::string_view)
      • Function portal::imgui::property(std::string_view, uint64_t&, uint64_t, uint64_t, std::string_view)
      • Function portal::imgui::property(std::string_view, float&, float, float, float, std::string_view)
      • Function portal::imgui::property(std::string_view, double&, float, double, double, std::string_view)
      • Function portal::imgui::property(std::string_view, glm::vec2&, float, float, float, std::string_view)
      • Function portal::imgui::property(EditorContext&, std::string_view, glm::vec3&, float, float, float, std::string_view)
      • Function portal::imgui::property(std::string_view, glm::vec4&, float, float, float, std::string_view)
      • Function portal::imgui::property_button
      • Function portal::imgui::property_color(std::string_view, glm::vec3&, std::string_view)
      • Function portal::imgui::property_color(std::string_view, glm::vec4&, std::string_view)
      • Template Function portal::imgui::property_dropdown
      • Function portal::imgui::property_input(std::string_view, int8_t&, int8_t, int8_t, ImGuiInputTextFlags, std::string_view)
      • Function portal::imgui::property_input(std::string_view, int16_t&, int16_t, int16_t, ImGuiInputTextFlags, std::string_view)
      • Function portal::imgui::property_input(std::string_view, int32_t&, int32_t, int32_t, ImGuiInputTextFlags, std::string_view)
      • Function portal::imgui::property_input(std::string_view, int64_t&, int64_t, int64_t, ImGuiInputTextFlags, std::string_view)
      • Function portal::imgui::property_input(std::string_view, uint8_t&, uint8_t, uint8_t, ImGuiInputTextFlags, std::string_view)
      • Function portal::imgui::property_input(std::string_view, uint16_t&, uint16_t, uint16_t, ImGuiInputTextFlags, std::string_view)
      • Function portal::imgui::property_input(std::string_view, uint32_t&, uint32_t, uint32_t, ImGuiInputTextFlags, std::string_view)
      • Function portal::imgui::property_input(std::string_view, uint64_t&, uint64_t, uint64_t, ImGuiInputTextFlags, std::string_view)
      • Function portal::imgui::property_multiline
      • Function portal::imgui::property_radio
      • Template Function portal::imgui::property_resource_reference_with_conversion
      • Function portal::imgui::property_slider(std::string_view, int&, int, int, std::string_view)
      • Function portal::imgui::property_slider(std::string_view, float&, float, float, ImGuiInputTextFlags, std::string_view)
      • Function portal::imgui::property_slider(std::string_view, glm::vec2&, float, float, std::string_view)
      • Function portal::imgui::property_slider(std::string_view, glm::vec3&, float, float, std::string_view)
      • Function portal::imgui::property_slider(std::string_view, glm::vec4&, float, float, std::string_view)
      • Function portal::imgui::push_id
      • Function portal::imgui::rect_offset(const ImRect&, const ImVec2)
      • Function portal::imgui::rect_offset(const ImRect&, const float, const float)
      • Function portal::imgui::resource_search_popup(EditorContext&, const std::string_view, ResourceType, ResourceReference<Resource>&, bool *, const std::string_view, const ImVec2)
      • Function portal::imgui::resource_search_popup(EditorContext&, std::string_view, ResourceReference<Resource>&, bool *, std::string_view, ImVec2, std::initializer_list<ResourceType>)
      • Function portal::imgui::resource_validity_and_name
      • Function portal::imgui::rgb
      • Template Function portal::imgui::search_widget
      • Function portal::imgui::set_tooltip
      • Function portal::imgui::shift_cursor(const float, const float)
      • Function portal::imgui::shift_cursor(const ImVec2)
      • Function portal::imgui::underline(const bool, const float, const float)
      • Function portal::imgui::underline(const ImU32, const bool, const float, const float)
      • Template Function portal::make_reference
      • Template Function portal::reference_cast
      • Function portal::renderer::diagnose_if_needed
      • Function portal::renderer::format_property
      • Function portal::renderer::get_element_number
      • Function portal::renderer::get_format_bytes_per_pixel
      • Function portal::renderer::to_descriptor_type
      • Function portal::renderer::to_property_container_type
      • Function portal::renderer::to_property_type
      • Function portal::renderer::to_shader_stage
      • Function portal::renderer::utils::calculate_mip_count
      • Function portal::renderer::utils::get_image_memory_size
      • Function portal::renderer::utils::is_depth_format
      • Function portal::renderer::utils::is_integer_format
      • Function portal::renderer::utils::is_stencil_format
      • Function portal::renderer::vulkan::allocation::get_vma_allocator
      • Function portal::renderer::vulkan::allocation::init
      • Function portal::renderer::vulkan::allocation::shutdown
      • Function portal::renderer::vulkan::check_driver_api_version_support
      • Function portal::renderer::vulkan::check_instance_extension_support
      • Function portal::renderer::vulkan::check_validation_layer_support
      • Function portal::renderer::vulkan::choose_present_mode
      • Function portal::renderer::vulkan::copy_image_to_image
      • Function portal::renderer::vulkan::find_image_type
      • Function portal::renderer::vulkan::get_max_usable_sample_count
      • Function portal::renderer::vulkan::get_message_type
      • Template Function portal::renderer::vulkan::get_uniform_pointer
      • Function portal::renderer::vulkan::is_compatible_input
      • Function portal::renderer::vulkan::rate_device_suitability
      • Function portal::renderer::vulkan::to_access_flag
      • Function portal::renderer::vulkan::to_address_mode
      • Function portal::renderer::vulkan::to_compare_op
      • Function portal::renderer::vulkan::to_descriptor_resource_type
      • Function portal::renderer::vulkan::to_descriptor_type
      • Function portal::renderer::vulkan::to_filter
      • Function portal::renderer::vulkan::to_format(ImageFormat)
      • Function portal::renderer::vulkan::to_format(vk::Format)
      • Function portal::renderer::vulkan::to_format(const reflection::Property&)
      • Function portal::renderer::vulkan::to_load_op
      • Function portal::renderer::vulkan::to_mipmap_mode
      • Function portal::renderer::vulkan::to_pipeline_stage
      • Function portal::renderer::vulkan::to_primitive_topology
      • Function portal::renderer::vulkan::to_shader_stage
      • Function portal::renderer::vulkan::to_surface_transform
      • Function portal::renderer::vulkan::transition_image_layout(const vk::CommandBuffer&, const vk::Image&, uint32_t, vk::ImageLayout, vk::ImageLayout)
      • Function portal::renderer::vulkan::transition_image_layout(const vk::CommandBuffer&, const Reference<Image>&, const uint32_t, const vk::ImageLayout, const vk::ImageLayout)
      • Function portal::renderer::vulkan::transition_image_layout(const vk::CommandBuffer&, const vk::Image&, uint32_t, vk::ImageLayout, vk::ImageLayout, vk::AccessFlags2, vk::AccessFlags2, vk::PipelineStageFlags2, vk::PipelineStageFlags2, vk::ImageAspectFlags)
      • Function portal::renderer::vulkan::transition_image_layout(const vk::CommandBuffer&, const Reference<Image>&, const uint32_t, const vk::ImageLayout, const vk::ImageLayout, const vk::AccessFlags2, const vk::AccessFlags2, const vk::PipelineStageFlags2, const vk::PipelineStageFlags2, const vk::ImageAspectFlags)
      • Function portal::renderer::vulkan::transition_image_layout(const vk::CommandBuffer&, const vk::Image&, const vk::ImageSubresourceRange&, vk::ImageLayout, vk::ImageLayout, vk::AccessFlags2, vk::AccessFlags2, vk::PipelineStageFlags2, vk::PipelineStageFlags2)
      • Function portal::renderer::vulkan::transition_image_layout(const vk::CommandBuffer&, const Reference<Image>&, const vk::ImageSubresourceRange&, const vk::ImageLayout, const vk::ImageLayout, const vk::AccessFlags2, const vk::AccessFlags2, const vk::PipelineStageFlags2, const vk::PipelineStageFlags2)
      • Function portal::renderer::vulkan::utils::get_view_type
      • Function portal::renderer::vulkan::utils::to_address_mode
      • Function portal::renderer::vulkan::utils::to_filter
      • Function portal::renderer::vulkan::utils::validate_prop
      • Function portal::resources::calculate_tangents
      • Function portal::resources::create_name_relative
      • Function portal::resources::extract_filter
      • Function portal::resources::extract_mipmap_mode
      • Function portal::resources::utils::to_resource_type
      • Template Function portal::to_uint64(T&)
      • Template Function portal::to_uint64(T)
      • Template Function portal::to_uint64(T)
      • Function portal::tree_node_with_icon(vk::DescriptorSet, vk::DescriptorSet, ImGuiID, ImGuiTreeNodeFlags, const char *, const char *, ImColor)
      • Function portal::tree_node_with_icon(const vk::DescriptorSet, const vk::DescriptorSet, const void *, const ImGuiTreeNodeFlags, const ImColor, const char *, …)
      • Function portal::tree_node_with_icon(const vk::DescriptorSet, const vk::DescriptorSet, const char *, const ImGuiTreeNodeFlags, const ImColor)
      • Function portal::TreeNodeStoreStackData
      • Function portal::utils::find_extension_type
      • Template Function portal::utils::to_resource_type()
      • Function portal::utils::to_resource_type(const Resource&)
      • Function portal::validate_and_create_meta_path
      • Function portal::validate_and_create_path
      • Function wrap_to_pi
      • Variable portal::CONFIGS_NAME
      • Variable portal::content_browser::MAX_INPUT_BUFFER_LENGTH
      • Variable portal::content_browser::s_rename_buffer
      • Variable portal::content_browser::thumbnail_size
      • Variable portal::CURRENT_DATABASE_VERSION
      • Variable portal::DEFAULT_CONFIGS_NAME
      • Variable portal::ecs::logger
      • Variable portal::g_asset_extensions
      • Variable portal::imgui::s_counter
      • Variable portal::imgui::s_id_buffer
      • Variable portal::imgui::s_label_id_buffer
      • Variable portal::imgui::s_ui_context_id
      • Variable portal::KEY_MAPPING
      • Variable portal::logger
      • Variable portal::logger
      • Variable portal::logger
      • Variable portal::logger
      • Variable portal::logger
      • Variable portal::logger
      • Variable portal::logger
      • Variable portal::logger
      • Variable portal::logger
      • Variable portal::logger
      • Variable portal::logger
      • Variable portal::logger
      • Variable portal::logger
      • Variable portal::MAX_SNAPSHOTS
      • Variable portal::null_entity
      • Variable portal::PORTAL_ENGINE_CONFIG_LOCATION
      • Variable portal::PORTAL_ENGINE_RESOURCES_LOCATION
      • Variable portal::PORTAL_ICON_FILE_NAME
      • Variable portal::renderer::logger
      • Variable portal::renderer::logger
      • Variable portal::renderer::vulkan::allocation::created
      • Variable portal::renderer::vulkan::allocation::memory_allocator
      • Variable portal::renderer::vulkan::color_write_mask
      • Variable portal::renderer::vulkan::ENABLE_VALIDATION_LAYERS
      • Variable portal::renderer::vulkan::logger
      • Variable portal::renderer::vulkan::MAX_POINT_LIGHTS
      • Variable portal::renderer::vulkan::MAX_SPOT_LIGHTS
      • Variable portal::renderer::vulkan::REQUIRED_DEVICE_EXTENSIONS
      • Variable portal::renderer::vulkan::skipped_messages
      • Variable portal::renderer::vulkan::VALIDATION_LAYERS
      • Variable portal::resources::logger
      • Variable portal::resources::logger
      • Variable portal::resources::logger
      • Variable portal::resources::logger
      • Variable portal::resources::logger
      • Variable portal::ROOT_DATABASE_METADATA_FILENAME
      • Define CASE
      • Define CASE
      • Define CASE
      • Define CASE
      • Define CASE
      • Define CASE
      • Define CASE
      • Define CASE
      • Define CASE
      • Define CASE
      • Define CASE
      • Define DECLARE_RESOURCE
      • Define GLFW_INCLUDE_VULKAN
      • Define GLFW_INCLUDE_VULKAN
      • Define IMGUI_DEFINE_MATH_OPERATORS
      • Define IMGUI_DELETE_MOVE_COPY
      • Define REGISTER_COMPONENT
      • Define STB_IMAGE_IMPLEMENTATION
      • Define TINYOBJLOADER_IMPLEMENTATION
      • Define VK_HANDLE_CAST
      • Define VMA_IMPLEMENTATION
      • Typedef portal::content_browser::Action
      • Typedef portal::DatabaseError
      • Typedef portal::imgui::OutlineFlags
      • Typedef portal::imgui::VectorAxis
      • Typedef portal::Reference
      • Typedef portal::renderer::SurfaceTransform
      • Typedef portal::ResourceDirtyFlags
      • Typedef portal::WeakReference
    • Portal Networking Api
      • Namespace portal
      • Namespace portal::network
      • Struct ConnectionInfo
      • Class Connection
      • Class ConnectionManager
      • Class Server
      • Enum ConnectionEnd
      • Enum ConnectionState
      • Function portal::network::is_valid_id_address
      • Function portal::network::resolve_address
    • CMake Functions API
      • Function portal_add_game
      • Function portal_game_configure_installer
      • Function portal_add_resources
      • Function portal_package_game
      • Function portal_install_game
      • Function portal_fetch_resources
      • Function portal_read_settings
      • Function portal_setup_compile_configs
      • Function portal_add_module
      • Function portal_add_dependency
      • Function portal_configure_pch
      • Function portal_install_module
      • Function portal_setup_config_pch
      • Function portal_register_docs
      • Function portal_build_tests
      • Function portal_add_test_target
  • Contributing ⚠️
    • Building ⚠️
    • Code Style ⚠️
    • Testing ⚠️
    • Documentation ⚠️
  • Development Status
Back to top
View this page
Edit this page

Struct GPUSceneLights¶

  • Defined in File rendering_types.h

Struct Documentation¶

struct GPUSceneLights¶

Public Members

GPUSceneDirectionLight directional_light¶
GPUScenePointLights point_lights¶
GPUSceneSpotLights spot_lights¶
Next
Struct GPUScenePointLights
Previous
Struct GPUSceneDirectionLight
Copyright © Copyright © 2026, Jonatan Nevo
Made with Sphinx and @pradyunsg's Furo
On this page
  • Struct GPUSceneLights
    • Struct Documentation
      • portal::renderer::vulkan::GPUSceneLights
        • directional_light
        • point_lights
        • spot_lights