Portal Core Api

File Hierarchy

• • Directory portal
    • Directory core
      • Directory concurrency
        • File asserion_lock.h
        • File reentrant_spin_lock.h
        • File spin_lock.h
        • File thread_base.cpp
        • File thread_base.h
      • Directory debug
        • File assert.h
        • File debug_allocator.cpp
        • File debug_allocator.h
        • File profile.h
      • Directory defines
        • File preprocessor.h
      • Directory events
        • File event.h
        • File event_handler.h
        • File event_types.h
      • Directory files
        • File file_system.cpp
        • File file_system.h
      • Directory jobs
        • File basic_coroutine.h
        • File job.cpp
        • File job.h
        • File job_stats.cpp
        • File job_stats.h
        • File scheduler.cpp
        • File scheduler.h
        • File task.h
        • File worker_queue.cpp
        • File worker_queue.h
      • Directory memory
        • File pool_allocator.h
        • File stack_allocator.cpp
        • File stack_allocator.h
      • Directory random
        • File mesmer_twisted_random.cpp
        • File mesmer_twisted_random.h
        • File random.cpp
        • File random.h
      • Directory reflection
        • File property.h
        • File property_concepts.h
      • Directory strings
        • Directory rapidhash
          • File rapidhash.h
        • File hash.h
        • File string_id.cpp
        • File string_id.h
        • File string_registry.cpp
        • File string_registry.h
        • File string_utils.cpp
        • File string_utils.h
      • File buffer.h
      • File buffer_stream.cpp
      • File buffer_stream.h
      • File common.h
      • File config.h.inc
      • File custom_logger_formatters.h
      • File flags.h
      • File glm.h
      • File log.cpp
      • File log.h
      • File timer.cpp
      • File timer.h
      • File type_traits.h
      • File variant.h
    • Directory platform
      • Directory core
        • Directory hal
          • File platform_logger.h
          • File thread.h
        • Directory linux
          • File linux_filesystem.cpp
          • File linux_platform_logger.cpp
          • File linux_platform_logger.h
          • File linux_thread.cpp
          • File linux_thread.h
        • Directory macos
          • File macos_filesystem.cpp
          • File macos_platform_logger.cpp
          • File macos_platform_logger.h
          • File macos_thread.cpp
          • File macos_thread.h
        • Directory windows
          • File string_utils.cpp
          • File string_utils.h
          • File windows_filesystem.cpp
          • File windows_platform_logger.cpp
          • File windows_platform_logger.h
          • File windows_thread.cpp
          • File windows_thread.h

Class Hierarchy

• • Namespace fmt
    • 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 >
  • Namespace llvm
    • Template Struct DenseMapInfo< portal::StringId >
  • Namespace portal
    • Namespace portal::details
      • Template Struct visitor
      • Enum Encoding
    • Namespace portal::jobs
      • Struct Counter
      • Class Scheduler
        • Struct Scheduler::WorkerContext
      • Enum WorkerIterationState
    • Namespace portal::reflection
      • Enum PropertyContainerType
      • Enum PropertyType
      • Struct Property
    • Struct Buffer
    • Template Struct concat
    • Template Struct concat< type_list< Ts... > >
    • Template Struct concat< type_list< Ts... >, type_list< Us... >, Rest... >
    • Template Struct concat< >
    • Struct FileStat
    • Template Struct filter
    • Template Struct filter< Pred >
    • Template Struct filter< Pred, T, Ts... >
    • Template Struct FlagTraits
    • Template Struct FlagTraits< EventCategoryBits >
    • Template Struct is_specialization_of
    • Template Struct is_specialization_of< Template< Args... >, Template >
    • Template Struct QueueSet
    • Struct StringId
    • Struct SwitchInformation
    • Struct ThreadSpecification
    • Template Struct type_list
    • Struct uint128_t
    • Class AssertionLock
    • Class BasicCoroutine
      • Struct BasicCoroutine::Promise
    • Template Class BucketPoolAllocator
    • Template Class BufferedAllocator
    • Class BufferStreamReader
    • Class BufferStreamWriter
    • Class Event
    • Class EventHandler
    • Class EventRunner
    • Class FileSystem
      • Struct FileSystem::FileDialogFilterItem
    • Class FinalizeJob
    • Template Class Flags
    • Class FreeCoTaskMemory
    • Template Class Job
    • Template Class Job< void >
    • Class JobBase
    • Class JobPromise
      • Class JobPromise::JobAwaiter
    • Class JobStats
      • Struct JobStats::GlobalStats
      • Struct JobStats::ThreadStats
    • Class LinuxThread
    • Class Log
      • Struct Log::LoggerSettings
    • Class MacOSThread
    • Class MesmerTwistedRandom
    • Class PerformanceProfiler
      • Struct PerformanceProfiler::PerFrameData
    • 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
      • Struct Task::Awaiter
      • Struct Task::FinalAwaiter
      • Struct Task::Promise
    • Class ThreadBase
    • Class Timer
    • Class WindowsThread
    • Class WorkerQueue
    • Enum EventCategoryBits
    • Enum EventType
    • Enum FileStatus
    • Enum JobPriority
    • Enum JobResultStatus
    • Enum SwitchType
    • Enum ThreadAffinity
    • Enum ThreadPriority
  • Namespace std
    • Template Struct hash< portal::StringId >
    • Template Struct hash< portal::uint128_t >

Full API

Namespaces

• Namespace fmt
  • Classes

• Namespace llvm
  • Classes

• Namespace portal
  • Namespaces
  • Classes
  • Enums
  • Functions
  • Typedefs
  • Variables

• Namespace portal::details
  • Classes
  • Enums
  • Functions

• Namespace portal::hash
  • Detailed Description
  • Functions

• Namespace portal::jobs
  • Classes
  • Enums
  • Variables

• Namespace portal::platform
  • Functions

• Namespace portal::reflection
  • Classes
  • Enums
  • Functions

• Namespace spdlog

• Namespace std
  • Namespaces
  • Classes

• Namespace std::string_view_literals

Classes and Structs

• Template Struct formatter< glm::vec2 >
  • Struct Documentation
    • fmt::formatter< glm::vec2 >
      • parse()
      • format()
      • presentation

• Template Struct formatter< glm::vec3 >
  • Struct Documentation
    • fmt::formatter< glm::vec3 >
      • parse()
      • format()
      • presentation

• Template Struct formatter< glm::vec4 >
  • Struct Documentation
    • fmt::formatter< glm::vec4 >
      • parse()
      • format()
      • presentation

• Template Struct formatter< portal::reflection::Property >
  • Struct Documentation
    • fmt::formatter< portal::reflection::Property >
      • format()
      • parse()

• Template Struct formatter< portal::StringId >
  • Struct Documentation
    • fmt::formatter< portal::StringId >
      • format()
      • parse()

• Template Struct formatter< portal::uint128_t >
  • Struct Documentation
    • fmt::formatter< portal::uint128_t >
      • parse()
      • format()
      • presentation

• Template Struct formatter< T >
  • Struct Documentation
    • fmt::formatter< T >
      • format()
      • parse()

• Template Struct DenseMapInfo< portal::StringId >
  • Struct Documentation
    • llvm::DenseMapInfo< portal::StringId >
      • getEmptyKey()
      • getTombstoneKey()
      • getHashValue()
      • isEqual()

• Struct BasicCoroutine::Promise
  • Nested Relationships
  • Struct Documentation
    • portal::BasicCoroutine::Promise
      • get_return_object()
      • unhandled_exception()
      • return_void()
      • initial_suspend()
      • final_suspend()

• Struct Buffer
  • Struct Documentation
    • portal::Buffer
      • Buffer()
      • Buffer()
      • Buffer()
      • Buffer()
      • Buffer()
      • Buffer()
      • Buffer()
      • operator=()
      • operator=()
      • ~Buffer()
      • operator==()
      • release()
      • zero_initialize()
      • read()
      • read()
      • write()
      • write()
      • operator bool()
      • operator[]()
      • as()
      • data_ptr()
      • data_ptr()
      • is_allocated()
      • as_string()
      • data
      • size
      • create()
      • copy()
      • copy()
      • copy_from()
      • allocate()

• Template Struct concat
  • Struct Documentation
    • portal::concat

• Template Struct concat< type_list< Ts… > >
  • Struct Documentation
    • portal::concat< type_list< Ts... > >
      • type

• Template Struct concat< type_list< Ts… >, type_list< Us… >, Rest… >
  • Struct Documentation
    • portal::concat< type_list< Ts... >, type_list< Us... >, Rest... >
      • type

• Template Struct concat< >
  • Struct Documentation
    • portal::concat<>
      • type

• Template Struct visitor
  • Inheritance Relationships
    • Base Type
  • Struct Documentation
    • portal::details::visitor

• Struct FileStat
  • Struct Documentation
    • portal::FileStat
      • is_file
      • is_directory
      • last_write_time
      • size

• Struct FileSystem::FileDialogFilterItem
  • Nested Relationships
  • Struct Documentation
    • portal::FileSystem::FileDialogFilterItem
      • name
      • spec

• Template Struct filter
  • Struct Documentation
    • portal::filter

• Template Struct filter< Pred >
  • Struct Documentation
    • portal::filter< Pred >
      • type

• Template Struct filter< Pred, T, Ts… >
  • Struct Documentation
    • portal::filter< Pred, T, Ts... >
      • rest
      • type

• Template Struct FlagTraits
  • Struct Documentation
    • portal::FlagTraits
      • is_bitmask
      • all_flags

• Template Struct FlagTraits< EventCategoryBits >
  • Struct Documentation
    • portal::FlagTraits< EventCategoryBits >
      • is_bitmask
      • all_flags

• Template Struct is_specialization_of
  • Inheritance Relationships
    • Base Type
  • Struct Documentation
    • portal::is_specialization_of

• Template Struct is_specialization_of< Template< Args… >, Template >
  • Inheritance Relationships
    • Base Type
  • Struct Documentation
    • portal::is_specialization_of< Template< Args... >, Template >

• Struct Counter
  • Struct Documentation
    • portal::jobs::Counter
      • count
      • blocking

• Struct Scheduler::WorkerContext
  • Nested Relationships
  • Struct Documentation
    • portal::jobs::Scheduler::WorkerContext
      • queue
      • rng
      • worker_id
      • job_cache
      • cache_index
      • iterations_since_steal_check
      • iterations_since_sample
      • CACHE_SIZE
      • STEAL_CHECK_INTERVAL
      • SAMPLE_INTERVAL

• Struct JobStats::GlobalStats
  • Nested Relationships
  • Struct Documentation
    • portal::JobStats::GlobalStats
      • total_work_executed
      • total_work_submitted
      • total_work_time_ns
      • average_work_time_us
      • min_work_time_ns
      • max_work_time_ns
      • work_by_priority
      • total_steal_attempts
      • total_steal_successes
      • steal_success_rate
      • average_local_queue_depth
      • average_stealable_queue_depth
      • max_queue_depth
      • total_idle_spins
      • total_idle_time_ns
      • idle_time_percentage
      • load_imbalance
      • start_time
      • last_reset
      • elapsed_seconds

• Struct JobStats::ThreadStats
  • Nested Relationships
  • Struct Documentation
    • portal::JobStats::ThreadStats
      • work_executed
      • work_submitted
      • total_work_time_ns
      • min_work_time_ns
      • max_work_time_ns
      • work_by_priority
      • steal_attempts
      • steal_successes
      • work_stolen
      • work_lost_to_thieves
      • total_queue_depth_samples
      • sum_local_queue_depth
      • sum_stealable_queue_depth
      • max_local_queue_depth
      • max_stealable_queue_depth
      • idle_spins
      • total_idle_time_ns
      • local_queue_hits
      • steal_queue_hits
      • global_queue_hits

• Struct Log::LoggerSettings
  • Nested Relationships
  • Struct Documentation
    • portal::Log::LoggerSettings
      • default_log_level
      • default_logger_name
      • application_name

• Struct PerformanceProfiler::PerFrameData
  • Nested Relationships
  • Struct Documentation
    • portal::PerformanceProfiler::PerFrameData
      • time
      • samples

• Template Struct QueueSet
  • Struct Documentation
    • portal::QueueSet
      • ItemType
      • QueueType
      • QueueSet()
      • enqueue()
      • enqueue_bulk()
      • try_dequeue()
      • try_dequeue_bulk()
      • queues

• Struct Property
  • Struct Documentation
    • portal::reflection::Property
      • operator==()
      • value
      • type
      • container_type
      • elements_number

• Struct StringId
  • Struct Documentation
    • portal::StringId
      • HashType
      • StringId()
      • StringId()
      • StringId()
      • StringId()
      • operator==()
      • id
      • string

• Struct SwitchInformation
  • Struct Documentation
    • portal::SwitchInformation
      • thread_id
      • time
      • type

• Struct Task::Awaiter
  • Nested Relationships
  • Struct Documentation
    • portal::Task::Awaiter
      • await_ready()
      • await_suspend()
      • await_resume()
      • await_resume()
      • handle

• Struct Task::FinalAwaiter
  • Nested Relationships
  • Struct Documentation
    • portal::Task::FinalAwaiter
      • await_ready()
      • await_suspend()
      • await_resume()

• Struct Task::Promise
  • Nested Relationships
  • Struct Documentation
    • portal::Task::Promise
      • get_return_object()
      • unhandled_exception()
      • return_value()
      • initial_suspend()
      • final_suspend()
      • return_void()
      • continuation
      • result

• Struct ThreadSpecification
  • Struct Documentation
    • portal::ThreadSpecification
      • name
      • priority
      • affinity
      • core

• Template Struct type_list
  • Struct Documentation
    • portal::type_list

• Struct uint128_t
  • Struct Documentation
    • portal::uint128_t
      • uint128_t()
      • uint128_t()
      • operator bool()
      • operator T()
      • operator~()
      • operator-()
      • operator--()
      • operator++()
      • operator+=()
      • operator-=()
      • operator*=()
      • operator<<=()
      • operator>>=()
      • operator|=()
      • operator&=()
      • operator%=()
      • operator/=()
      • lo
      • hi
      • umul64_64_128()
      • operator&
      • operator|
      • operator<<
      • operator>>
      • operator+
      • operator-
      • operator*
      • operator/
      • operator%
      • operator==
      • operator<
      • __bit_width
      • __countr_zero
      • operator!=
      • operator>
      • operator>=

• Template Struct hash< portal::StringId >
  • Struct Documentation
    • std::hash< portal::StringId >
      • operator()()

• Template Struct hash< portal::uint128_t >
  • Struct Documentation
    • std::hash< portal::uint128_t >
      • operator()()

• Class AssertionLock
  • Class Documentation
    • portal::AssertionLock
      • AssertionLock()
      • lock()
      • unlock()

• Class BasicCoroutine
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • portal::BasicCoroutine
      • promise_type
      • portal::BasicCoroutine::Promise
        • get_return_object()
        • unhandled_exception()
        • return_void()
        • initial_suspend()
        • final_suspend()

• Template Class BucketPoolAllocator
  • Class Documentation
    • portal::BucketPoolAllocator
      • BucketPoolAllocator()
      • alloc()
      • free()
      • clear()
      • get_allocation_size()
      • bucket_size
      • pool_size

• Template Class BufferedAllocator
  • Class Documentation
    • portal::BufferedAllocator
      • BufferedAllocator()
      • BufferedAllocator()
      • swap_buffers()
      • alloc()
      • alloc()
      • free()
      • free()
      • clear()
      • clear()
      • get_current_allocator()
      • get_allocator()

• Class BufferStreamReader
  • Inheritance Relationships
    • Base Types
  • Class Documentation
    • portal::BufferStreamReader
      • BufferStreamReader()
      • position()
      • xsgetn()
      • seekoff()

• Class BufferStreamWriter
  • Inheritance Relationships
    • Base Types
  • Class Documentation
    • portal::BufferStreamWriter
      • BufferStreamWriter()
      • get_buffer()
      • size()
      • full()
      • overflow()
      • xsputn()

• Class Event
  • Class Documentation
    • portal::Event
      • ~Event()
      • get_event_type()
      • get_name()
      • get_category()
      • to_string()
      • is_handled()
      • handled

• Class EventHandler
  • Class Documentation
    • portal::EventHandler
      • ~EventHandler()
      • on_event()

• Class EventRunner
  • Class Documentation
    • portal::EventRunner
      • EventRunner()
      • run_on()

• Class FileSystem
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • portal::FileSystem
      • get_working_directory()
      • set_working_directory()
      • create_directory()
      • create_directory()
      • exists()
      • exists()
      • remove()
      • move()
      • copy()
      • rename()
      • rename_filename()
      • stat_file()
      • is_file()
      • is_directory()
      • is_newer()
      • get_last_write_time()
      • get_unique_file_name()
      • write_file()
      • write_file()
      • write_file()
      • read_chunk()
      • read_file_binary()
      • read_file_string()
      • try_open_file()
      • try_open_file_and_wait()
      • open_file_dialog()
      • open_folder_dialog()
      • save_file_dialog()
      • show_file_in_explorer()
      • open_directory_in_explorer()
      • open_externally()
      • has_environment_variable()
      • set_environment_variable()
      • get_environment_variable()
      • get_binary_path()
      • get_resource_path()
      • get_root_path()
      • get_data_home()
      • get_config_home()
      • get_cache_dir()
      • get_state_dir()
      • get_desktop_folder()
      • get_documents_folder()
      • get_download_folder()
      • get_pictures_folder()
      • get_public_folder()
      • get_music_folder()
      • get_video_folder()
      • portal::FileSystem::FileDialogFilterItem
        • name
        • spec

• Class FinalizeJob
  • Class Documentation
    • portal::FinalizeJob
      • await_ready()
      • await_suspend()
      • await_resume()

• Template Class Flags
  • Class Documentation
    • portal::Flags
      • MaskType
      • Flags()
      • Flags()
      • Flags()
      • Flags()
      • operator<=>()
      • operator!()
      • operator&()
      • operator|()
      • operator^()
      • operator~()
      • operator=()
      • operator|=()
      • operator&=()
      • operator^=()
      • operator bool()
      • operator MaskType()
      • get()

• Class FreeCoTaskMemory
  • Class Documentation
    • portal::FreeCoTaskMemory
      • FreeCoTaskMemory()
      • ~FreeCoTaskMemory()

• Template Class Job
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • portal::Job
      • promise_type
      • handle_type
      • result()
      • Job()
      • Job()
      • operator=()
      • ~Job()

• Template Class Job< void >
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • portal::Job< void >
      • promise_type
      • handle_type
      • result()
      • Job()
      • Job()
      • operator=()

• Class JobBase
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • portal::JobBase
      • handle_type
      • JobBase()
      • JobBase()
      • JobBase()
      • operator=()
      • operator=()
      • ~JobBase()
      • operator co_await()
      • set_dispatched()
      • set_scheduler()
      • set_counter()
      • is_dispatched()
      • is_completed()
      • handle
      • dispatched
      • owning_result

• Class JobPromise
  • Nested Relationships
    • Nested Types
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • portal::JobPromise
      • JobPromise()
      • initial_suspend()
      • final_suspend()
      • unhandled_exception()
      • get_result()
      • add_switch_information()
      • initialize_result()
      • destroy_result()
      • operator new()
      • operator delete()
      • set_scheduler()
      • set_counter()
      • set_continuation()
      • get_continuation()
      • get_counter()
      • get_scheduler()
      • is_completed()
      • operator co_await()
      • get_allocated_size()
      • continuation
      • result
      • completed
      • counter
      • scheduler
      • switch_information
      • allocate_result()
      • deallocate_result()
      • portal::JobPromise::JobAwaiter
        • JobAwaiter()
        • await_ready()
        • await_suspend()
        • await_resume()
        • await_resume()

• Class JobPromise::JobAwaiter
  • Nested Relationships
  • Class Documentation
    • portal::JobPromise::JobAwaiter
      • JobAwaiter()
      • await_ready()
      • await_suspend()
      • await_resume()
      • await_resume()

• Class Scheduler
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • portal::jobs::Scheduler
      • Scheduler()
      • ~Scheduler()
      • Scheduler()
      • operator=()
      • operator=()
      • wait_for_counter()
      • wait_for_jobs()
      • wait_for_jobs()
      • wait_for_jobs()
      • wait_for_jobs()
      • wait_for_jobs()
      • wait_for_job()
      • wait_for_job()
      • dispatch_jobs()
      • dispatch_job()
      • dispatch_jobs()
      • dispatch_jobs()
      • dispatch_job()
      • get_stats()
      • get_stats()
      • main_thread_do_work()
      • get_tls_worker_id()
      • portal::jobs::Scheduler::WorkerContext
        • queue
        • rng
        • worker_id
        • job_cache
        • cache_index
        • iterations_since_steal_check
        • iterations_since_sample
        • CACHE_SIZE
        • STEAL_CHECK_INTERVAL
        • SAMPLE_INTERVAL

• Class JobStats
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • portal::JobStats
      • QueueType
        • Local
        • Stealable
        • Global
      • JobStats()
      • record_work_submitted()
      • record_work_executed()
      • record_steal_attempt()
      • record_work_stolen_from_me()
      • record_queue_depth()
      • record_idle_spin()
      • record_idle_time()
      • record_queue_hit()
      • aggregate()
      • reset()
      • log()
      • get_thread_stats()
      • get_global_stats()
      • portal::JobStats::GlobalStats
        • total_work_executed
        • total_work_submitted
        • total_work_time_ns
        • average_work_time_us
        • min_work_time_ns
        • max_work_time_ns
        • work_by_priority
        • total_steal_attempts
        • total_steal_successes
        • steal_success_rate
        • average_local_queue_depth
        • average_stealable_queue_depth
        • max_queue_depth
        • total_idle_spins
        • total_idle_time_ns
        • idle_time_percentage
        • load_imbalance
        • start_time
        • last_reset
        • elapsed_seconds
      • portal::JobStats::ThreadStats
        • work_executed
        • work_submitted
        • total_work_time_ns
        • min_work_time_ns
        • max_work_time_ns
        • work_by_priority
        • steal_attempts
        • steal_successes
        • work_stolen
        • work_lost_to_thieves
        • total_queue_depth_samples
        • sum_local_queue_depth
        • sum_stealable_queue_depth
        • max_local_queue_depth
        • max_stealable_queue_depth
        • idle_spins
        • total_idle_time_ns
        • local_queue_hits
        • steal_queue_hits
        • global_queue_hits

• Class LinuxThread
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • portal::LinuxThread
      • LinuxThread()
      • set_name()
      • set_affinity()
      • set_priority()

• Class Log
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • portal::Log
      • LogLevel
        • Trace
        • Debug
        • Info
        • Warn
        • Error
        • Fatal
      • init()
      • init()
      • shutdown()
      • get_logger()
      • set_default_log_level()
      • has_tag()
      • set_tag_level()
      • enable_tag()
      • with_context()
      • print_message_tag()
      • print_message_tag()
      • print_message()
      • print_message()
      • print_assert_message()
      • print_assert_message()
      • portal::Log::LoggerSettings
        • default_log_level
        • default_logger_name
        • application_name

• Class MacOSThread
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • portal::MacOSThread
      • MacOSThread()
      • set_name()
      • set_affinity()
      • set_priority()

• Class MesmerTwistedRandom
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • portal::MesmerTwistedRandom
      • init()
      • init()
      • get_uint()
      • get_uint()
      • get_float()
      • get_float()

• Class PerformanceProfiler
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • portal::PerformanceProfiler
      • set_frame_timing()
      • clear()
      • portal::PerformanceProfiler::PerFrameData
        • time
        • samples

• Template Class PoolAllocator
  • Class Documentation
    • portal::PoolAllocator
      • PoolAllocator()
      • alloc()
      • free()
      • clear()
      • pool_size

• Class Random
  • Inheritance Relationships
    • Derived Type
  • Class Documentation
    • portal::Random
      • ~Random()
      • init()
      • init()
      • get_uint()
      • get_uint()
      • get_float()
      • get_float()
      • get_vec3()
      • get_vec3()

• Template Class ReentrantSpinLock
  • Class Documentation
    • portal::ReentrantSpinLock
      • ReentrantSpinLock()
      • try_lock()
      • lock()
      • unlock()

• Template Class ResultPromise
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • portal::ResultPromise
      • get_return_object()
      • return_value()
      • get_return_object_on_allocation_failure()

• Template Class ResultPromise< void >
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • portal::ResultPromise< void >
      • get_return_object()
      • return_void()
      • get_return_object_on_allocation_failure()

• Class ScopedLogContext
  • Class Documentation
    • portal::ScopedLogContext
      • ScopedLogContext()
      • ~ScopedLogContext()

• Class ScopedPerformanceTimer
  • Class Documentation
    • portal::ScopedPerformanceTimer
      • ScopedPerformanceTimer()
      • ~ScopedPerformanceTimer()

• Template Class ScopedTimer
  • Class Documentation
    • portal::ScopedTimer
      • ScopedTimer()
      • ~ScopedTimer()

• Class source_location_flag_formatter
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • portal::source_location_flag_formatter
      • source_location_flag_formatter()
      • format()
      • clone()

• Class SpinLock
  • Class Documentation
    • portal::SpinLock
      • SpinLock()
      • try_lock()
      • lock()
      • unlock()

• Class StackAllocator
  • Class Documentation
    • portal::StackAllocator
      • marker
      • StackAllocator()
      • StackAllocator()
      • alloc()
      • alloc()
      • free()
      • free()
      • get_marker()
      • get_size()
      • free_to_marker()
      • clear()
      • resize()

• Class StringRegistry
  • Class Documentation
    • portal::StringRegistry
      • store()
      • find()

• Class SuspendJob
  • Class Documentation
    • portal::SuspendJob
      • await_ready()
      • await_suspend()
      • await_resume()

• Template Class Task
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • portal::Task
      • promise_type
      • Task()
      • Task()
      • operator=()
      • ~Task()
      • Task()
      • operator=()
      • operator co_await()
      • portal::Task::Awaiter
        • await_ready()
        • await_suspend()
        • await_resume()
        • await_resume()
        • handle
      • portal::Task::FinalAwaiter
        • await_ready()
        • await_suspend()
        • await_resume()
      • portal::Task::Promise
        • get_return_object()
        • unhandled_exception()
        • return_value()
        • initial_suspend()
        • final_suspend()
        • return_void()
        • continuation
        • result

• Class ThreadBase
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • portal::ThreadBase
      • ThreadBase()
      • ThreadBase()
      • ~ThreadBase()
      • ThreadBase()
      • ThreadBase()
      • operator=()
      • operator=()
      • joinable()
      • join()
      • detach()
      • get_id()
      • get_name()
      • request_stop()
      • try_cancel_and_join()
      • spec
      • thread
      • make_callable()
      • set_name()

• Class Timer
  • Class Documentation
    • portal::Timer
      • Seconds
      • Milliseconds
      • Microseconds
      • Nanoseconds
      • Clock
      • DefaultResolution
      • Timer()
      • start()
      • lap()
      • stop()
      • elapsed()
      • tick()
      • is_running()

• Class WindowsThread
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • portal::WindowsThread
      • WindowsThread()
      • set_name()
      • set_affinity()
      • set_priority()

• Class WorkerQueue
  • Class Documentation
    • portal::WorkerQueue
      • submit_job()
      • submit_job_batch()
      • try_pop()
      • try_pop_bulk()
      • migrate_jobs_to_stealable()
      • attempt_steal()
      • get_local_count()
      • get_stealable_count()

Enums

• Enum Encoding
  • Enum Documentation
    • Encoding
      • UTF8
      • ANSI

• Enum EventCategoryBits
  • Enum Documentation
    • EventCategoryBits
      • Unknown
      • Window
      • Input

• Enum EventType
  • Enum Documentation
    • EventType
      • Unknown
      • WindowClose
      • WindowMinimize
      • WindowResize
      • WindowFocus
      • WindowLostFocus
      • WindowMoved
      • WindowTitleBarHit
      • KeyPressed
      • KeyReleased
      • KeyRepeat
      • MouseMoved
      • MouseScrolled
      • SetMouseCursor

• Enum FileStatus
  • Enum Documentation
    • FileStatus
      • Success
      • Invalid
      • Locked
      • OtherError

• Enum JobPriority
  • Enum Documentation
    • JobPriority
      • Low
      • Normal
      • High

• Enum JobResultStatus
  • Enum Documentation
    • JobResultStatus
      • Unknown
      • Missing
      • VoidType

• Enum WorkerIterationState
  • Enum Documentation
    • WorkerIterationState
      • Executed
      • FilledCache
      • EmptyQueue

• Enum PropertyContainerType
  • Enum Documentation
    • PropertyContainerType
      • invalid
      • scalar
      • array
      • string
      • null_term_string
      • vector
      • matrix
      • object

• Enum PropertyType
  • Enum Documentation
    • PropertyType
      • binary
      • integer8
      • integer16
      • integer32
      • integer64
      • integer128
      • floating32
      • floating64
      • character
      • boolean
      • object
      • null_term_string
      • string
      • invalid

• Enum SwitchType
  • Enum Documentation
    • SwitchType
      • Start
      • Resume
      • Pause
      • Finish
      • Error

• Enum ThreadAffinity
  • Enum Documentation
    • ThreadAffinity
      • Default
      • Core
      • CoreLean

• Enum ThreadPriority
  • Enum Documentation
    • ThreadPriority
      • Low
      • Default
      • High

Functions

• Template Function add_overflow_impl
  • Function Documentation
    • add_overflow_impl()

• Template Function operator&(BitType, const portal::Flags<BitType>&)
  • Function Documentation

• Template Function operator&(BitType, BitType)
  • Function Documentation

• Template Function operator^(BitType, const portal::Flags<BitType>&)
  • Function Documentation

• Template Function operator^(BitType, BitType)
  • Function Documentation

• Template Function operator|(BitType, const portal::Flags<BitType>&)
  • Function Documentation

• Template Function operator|(BitType, BitType)
  • Function Documentation

• Template Function operator~
  • Function Documentation

• Function portal::add_to_platform_folders_form_file
  • Function Documentation
    • add_to_platform_folders_form_file()

• Function portal::details::to_wstring
  • Function Documentation
    • to_wstring()

• Template Function portal::details::visitor
  • Function Documentation
    • visitor()

• Template Function portal::execute
  • Function Documentation
    • execute()

• Template Function portal::from_string
  • Function Documentation
    • from_string()

• Function portal::get_appdata
  • Function Documentation
    • get_appdata()

• Function portal::get_appdata_local
  • Function Documentation
    • get_appdata_local()

• Function portal::get_bundle
  • Function Documentation
    • get_bundle()

• Function portal::get_home()
  • Function Documentation

• Function portal::get_home()
  • Function Documentation

• Function portal::get_known_windows_folder
  • Function Documentation
    • get_known_windows_folder()

• Function portal::get_linux_folder_default
  • Function Documentation
    • get_linux_folder_default()

• Function portal::get_platform_folders
  • Function Documentation
    • get_platform_folders()

• Function portal::hash::rapidhash(const char *, const size_t)
  • Function Documentation
    • rapidhash()

• Function portal::hash::rapidhash(const std::string_view)
  • Function Documentation
    • rapidhash()

• Function portal::hash::rapidhash(const std::string&)
  • Function Documentation
    • rapidhash()

• Function portal::hash::rapidhash(const char *)
  • Function Documentation
    • rapidhash()

• Template Function portal::hash::rapidhash(const char(&))
  • Function Documentation

• Template Function portal::match
  • Function Documentation
    • match()

• Function portal::platform::get_platform_sinks
  • Function Documentation
    • get_platform_sinks()

• Function portal::platform::print_assert_dialog
  • Function Documentation
    • print_assert_dialog()

• Function portal::reflection::get_float_type
  • Function Documentation
    • get_float_type()

• Function portal::reflection::get_integer_type
  • Function Documentation
    • get_integer_type()

• Function portal::reflection::get_property_size
  • Function Documentation
    • get_property_size()

• Template Function portal::reflection::get_property_type
  • Function Documentation
    • get_property_type()

• Function portal::throw_on_relative
  • Function Documentation
    • throw_on_relative()

• Template Function portal::to_string
  • Function Documentation
    • to_string()

• Function portal::utf16_to_utf8
  • Function Documentation
    • utf16_to_utf8()

• Function PORTAL_DEBUG_BREAK_HELPER
  • Function Documentation
    • PORTAL_DEBUG_BREAK_HELPER()

• Function rapid_mix
  • Function Documentation
    • rapid_mix()

• Function rapid_mum
  • Function Documentation
    • rapid_mum()

• Function rapid_read32
  • Function Documentation
    • rapid_read32()

• Function rapid_read64
  • Function Documentation
    • rapid_read64()

• Function rapidhash
  • Function Documentation
    • rapidhash()

• Function rapidhash_internal
  • Function Documentation
    • rapidhash_internal()

• Function rapidhash_withSeed
  • Function Documentation
    • rapidhash_withSeed()

• Function rapidhashMicro
  • Function Documentation
    • rapidhashMicro()

• Function rapidhashMicro_internal
  • Function Documentation
    • rapidhashMicro_internal()

• Function rapidhashMicro_withSeed
  • Function Documentation
    • rapidhashMicro_withSeed()

• Function rapidhashNano
  • Function Documentation
    • rapidhashNano()

• Function rapidhashNano_internal
  • Function Documentation
    • rapidhashNano_internal()

• Function rapidhashNano_withSeed
  • Function Documentation
    • rapidhashNano_withSeed()

• Template Function sub_overflow_impl
  • Function Documentation
    • sub_overflow_impl()

Variables

• Variable portal::BUCKET_SIZE
  • Variable Documentation
    • BUCKET_SIZE

• Variable portal::default_pattern
  • Variable Documentation
    • default_pattern

• Variable portal::DEFAULT_SIZE
  • Variable Documentation
    • DEFAULT_SIZE

• Variable portal::g_job_promise_allocator
  • Variable Documentation
    • g_job_promise_allocator

• Variable portal::g_job_result_allocator
  • Variable Documentation
    • g_job_result_allocator

• Variable portal::g_settings
  • Variable Documentation
    • g_settings

• Variable portal::INVALID_STRING_ID
  • Variable Documentation
    • INVALID_STRING_ID

• Variable portal::INVALID_STRING_VIEW
  • Variable Documentation
    • INVALID_STRING_VIEW

• Variable portal::is_specialization_of_v
  • Variable Documentation
    • is_specialization_of_v

• Variable portal::JOB_POOL_SIZE
  • Variable Documentation
    • JOB_POOL_SIZE

• Variable portal::jobs::logger
  • Variable Documentation
    • logger

• Variable portal::logger
  • Variable Documentation
    • logger

• Variable portal::logger
  • Variable Documentation
    • logger

• Variable portal::logger
  • Variable Documentation
    • logger

• Variable portal::logger
  • Variable Documentation
    • logger

• Variable portal::MAX_STRING_ID
  • Variable Documentation
    • MAX_STRING_ID

• Variable portal::s_bundle_instance
  • Variable Documentation
    • s_bundle_instance

• Variable rapid_secret
  • Variable Documentation
    • rapid_secret

Defines

• Define _likely_
  • Define Documentation
    • _likely_

• Define _unlikely_
  • Define Documentation
    • _unlikely_

• Define add_overflow
  • Define Documentation
    • add_overflow

• Define ASSERT_LOCK
  • Define Documentation
    • ASSERT_LOCK

• Define ASSERT_LOCK_GUARD
  • Define Documentation
    • ASSERT_LOCK_GUARD

• Define ASSERT_UNLOCK
  • Define Documentation
    • ASSERT_UNLOCK

• Define COMPILED_PLATFORM_HEADER
  • Define Documentation
    • COMPILED_PLATFORM_HEADER

• Define ENABLE_JOB_STATS
  • Define Documentation
    • ENABLE_JOB_STATS

• Define EVENT_CLASS_CATEGORY
  • Define Documentation
    • EVENT_CLASS_CATEGORY

• Define EVENT_CLASS_TYPE
  • Define Documentation
    • EVENT_CLASS_TYPE

• Define LOG_DEBUG
  • Define Documentation
    • LOG_DEBUG

• Define LOG_DEBUG_TAG
  • Define Documentation
    • LOG_DEBUG_TAG

• Define LOG_ERROR
  • Define Documentation
    • LOG_ERROR

• Define LOG_ERROR_TAG
  • Define Documentation
    • LOG_ERROR_TAG

• Define LOG_FATAL
  • Define Documentation
    • LOG_FATAL

• Define LOG_FATAL_TAG
  • Define Documentation
    • LOG_FATAL_TAG

• Define LOG_INFO
  • Define Documentation
    • LOG_INFO

• Define LOG_INFO_TAG
  • Define Documentation
    • LOG_INFO_TAG

• Define LOG_TRACE
  • Define Documentation
    • LOG_TRACE

• Define LOG_TRACE_TAG
  • Define Documentation
    • LOG_TRACE_TAG

• Define LOG_WARN
  • Define Documentation
    • LOG_WARN

• Define LOG_WARN_TAG
  • Define Documentation
    • LOG_WARN_TAG

• Define LOGGER_DEBUG
  • Define Documentation
    • LOGGER_DEBUG

• Define LOGGER_ERROR
  • Define Documentation
    • LOGGER_ERROR

• Define LOGGER_FATAL
  • Define Documentation
    • LOGGER_FATAL

• Define LOGGER_INFO
  • Define Documentation
    • LOGGER_INFO

• Define LOGGER_TRACE
  • Define Documentation
    • LOGGER_TRACE

• Define LOGGER_WARN
  • Define Documentation
    • LOGGER_WARN

• Define PORTAL_ASSERT
  • Define Documentation
    • PORTAL_ASSERT

• Define PORTAL_ASSERT_MESSAGE_BOX
  • Define Documentation
    • PORTAL_ASSERT_MESSAGE_BOX

• Define PORTAL_ASSERT_MESSAGE_INTERNAL
  • Define Documentation
    • PORTAL_ASSERT_MESSAGE_INTERNAL

• Define PORTAL_DEBUG_BREAK
  • Define Documentation
    • PORTAL_DEBUG_BREAK

• Define PORTAL_ENABLE_ASSERTS
  • Define Documentation
    • PORTAL_ENABLE_ASSERTS

• Define PORTAL_EXPLICIT_STATIC
  • Define Documentation
    • PORTAL_EXPLICIT_STATIC

• Define PORTAL_FORCE_INLINE
  • Define Documentation
    • PORTAL_FORCE_INLINE

• Define PORTAL_FRAME_MARK
  • Define Documentation
    • PORTAL_FRAME_MARK

• Define PORTAL_FRAME_MARK_END
  • Define Documentation
    • PORTAL_FRAME_MARK_END

• Define PORTAL_FRAME_MARK_START
  • Define Documentation
    • PORTAL_FRAME_MARK_START

• Define PORTAL_HAS_CONSOLE
  • Define Documentation

• Define PORTAL_HAS_CONSOLE
  • Define Documentation

• Define PORTAL_HASH_CONSTEXPR
  • Define Documentation
    • PORTAL_HASH_CONSTEXPR

• Define PORTAL_JOIN
  • Define Documentation
    • PORTAL_JOIN

• Define PORTAL_NAME_THREAD
  • Define Documentation
    • PORTAL_NAME_THREAD

• Define PORTAL_PRIVATE_JOIN
  • Define Documentation
    • PORTAL_PRIVATE_JOIN

• Define PORTAL_PRIVATE_STRINGIZE
  • Define Documentation
    • PORTAL_PRIVATE_STRINGIZE

• Define PORTAL_PROF_LOCK
  • Define Documentation
    • PORTAL_PROF_LOCK

• Define PORTAL_PROF_ZONE
  • Define Documentation
    • PORTAL_PROF_ZONE

• Define PORTAL_STRINGIZE
  • Define Documentation
    • PORTAL_STRINGIZE

• Define PORTAL_TRACE_ALLOC
  • Define Documentation
    • PORTAL_TRACE_ALLOC

• Define PORTAL_TRACE_FREE
  • Define Documentation
    • PORTAL_TRACE_FREE

• Define PORTAL_TRACE_REALLOC
  • Define Documentation
    • PORTAL_TRACE_REALLOC

• Define RAPIDHASH_ALWAYS_INLINE
  • Define Documentation
    • RAPIDHASH_ALWAYS_INLINE

• Define RAPIDHASH_COMPACT
  • Define Documentation
    • RAPIDHASH_COMPACT

• Define RAPIDHASH_CONSTEXPR
  • Define Documentation
    • RAPIDHASH_CONSTEXPR

• Define RAPIDHASH_FAST
  • Define Documentation
    • RAPIDHASH_FAST

• Define RAPIDHASH_INLINE
  • Define Documentation
    • RAPIDHASH_INLINE

• Define RAPIDHASH_INLINE_CONSTEXPR
  • Define Documentation
    • RAPIDHASH_INLINE_CONSTEXPR

• Define RAPIDHASH_LITTLE_ENDIAN
  • Define Documentation
    • RAPIDHASH_LITTLE_ENDIAN

• Define RAPIDHASH_NOEXCEPT
  • Define Documentation
    • RAPIDHASH_NOEXCEPT

• Define SCOPED_TIMER
  • Define Documentation
    • SCOPED_TIMER

• Define SOURCE_LOC
  • Define Documentation
    • SOURCE_LOC

• Define STRING_ID
  • Define Documentation
    • STRING_ID

• Define sub_overflow
  • Define Documentation
    • sub_overflow

Typedefs

• Typedef portal::concat_t
  • Typedef Documentation
    • concat_t

• Typedef portal::DoubleBufferedAllocator
  • Typedef Documentation
    • DoubleBufferedAllocator

• Typedef portal::EventCategory
  • Typedef Documentation
    • EventCategory

• Typedef portal::filter_t
  • Typedef Documentation
    • filter_t

• Typedef portal::Thread
  • Typedef Documentation
    • Thread