Inheritance diagram for Cogs::Core::CaptureComponent:
Static Public Member Functions | |
| static void | registerType () |
 Static Public Member Functions inherited from Cogs::ComponentModel::Component | |
| static COGSFOUNDATION_API void | registerType () |
| Register the Component type in the global type database. | |
| static COGSFOUNDATION_API Reflection::TypeId | getComponentTypeId (const StringView &name) |
| Get the type id of the component type with the given name. | |
Public Attributes | |
| CaptureMode | mode = CaptureMode::Scene |
| Specify type of capture. | |
| CaptureSceneMode | sceneMode = CaptureSceneMode::Forward |
| Specify rendering mode when mode is scene. | |
| glm::vec2 | size |
| CaptureFormat | format = CaptureFormat::PNG |
| Specifices the format of the captured data. | |
| int | framesToCapture = 0 |
| Enable capture for the given number of frames. | |
| bool | dropFrames = true |
| Allow capture to drop frames. | |
| bool | recordToDisc = false |
| Write capture frames to disc. | |
| std::string | recordPath |
| Path to directory where captured frames are stored. | |
Additional Inherited Members | |
| Public Member Functions inherited from Cogs::ComponentModel::Component | |
| class Entity * | getContainer () const |
| Get the container currently owning this component instance. | |
| void | setContainer (class Entity *container) |
| Set the container owning this component instance. | |
| template<typename ComponentType > | |
| ComponentType * | getComponent () const |
| COGSFOUNDATION_API Component * | getComponent (const Reflection::Name &name) const |
| COGSFOUNDATION_API Component * | getComponent (const Reflection::TypeId &id) const |
| template<typename ComponentType > | |
| ComponentHandle | getComponentHandle () const |
| COGSFOUNDATION_API ComponentHandle | getComponentHandle (const Reflection::Name &name) const |
| COGSFOUNDATION_API ComponentHandle | getComponentHandle (const Reflection::TypeId &id) const |
| void | setActive () |
| Sets the component to the ComponentFlags::Active state. | |
| bool | isActive () const |
| Gets if the component is currently set to the ComponentFlags::Active state. | |
| void | setChanged () |
| Sets the component to the ComponentFlags::Changed state with carry. | |
| void | setChangedTransient () |
| Sets the component to the ComponentFlags::Changed state without carry. | |
| void | setFieldChanged (const Reflection::FieldId fieldId) |
| Sets the component to the ComponentFlags::Changed state without carry. | |
| template<typename ClassType , typename FieldType > | |
| void | setFieldChanged (FieldType ClassType::*field) |
| Sets a flag indicating that the given field has changed. | |
| void | setFieldChangedTransient (const Reflection::FieldId fieldId) |
| Sets the component to the ComponentFlags::Changed state without carry. | |
| bool | hasChanged () const |
| bool | hasAnyfieldChanged () const |
| Gets if any fields have been changed. | |
| bool | hasFieldChanged (const Reflection::FieldId fieldId) const |
| Gets if the field with the given id on this component instance has changed. | |
| template<typename ClassType , typename FieldType > | |
| bool | hasFieldChanged (FieldType ClassType::*field) const |
| Gets if the given field has changed. | |
| void | resetCarryChanged () |
| Reset the CarryChanged flag. Called at start of redraw. See ComponentFlags::CarryChanged. | |
| void | resetChanged () |
| Resets the changed state of the component, respecting any carry state set. | |
| template<typename ClassType , typename FieldType > | |
| Reflection::FieldId | getFieldId (FieldType ClassType::*field) const |
| Gets field ID of the given field. | |
| void | resetFieldsChanged () |
| Resets the state of all changed field flags. | |
| void | resetFieldChanged (const Reflection::FieldId fieldId) |
| Resets the changed state of the given fieldId. | |
| template<typename ClassType , typename FieldType > | |
| void | resetFieldChanged (FieldType ClassType::*field) |
| Resets the changed state of the given field. | |
| constexpr void | setFlags (const uint32_t flags) |
| Override all flags of the Component, setting the given flags. | |
| constexpr void | setFlag (const uint32_t flag) |
| Set the given flags. Does not override the currently set flags. | |
| constexpr void | unsetFlag (const uint32_t flag) |
| Unset the given flag. Does not remove the status of other than the given flags. | |
| constexpr bool | isSet (const uint32_t flag) const |
| Checks if the given flag is set. Requires exact bit match if test of several bits. | |
| constexpr void | setTypeId (const Reflection::TypeId typeId) |
| Set the Reflection::TypeId of the component. | |
| constexpr Reflection::TypeId | getTypeId () const |
| Get the Reflection::TypeId of the component. | |
| COGSFOUNDATION_API const Reflection::Type & | getType () const |
| Get the full Reflection::Type of the component. | |
| constexpr void | setIndex (const ComponentIndex index) |
| Set the components pool index. For internal use only. | |
| constexpr ComponentIndex | getIndex () const |
| Get the components pool index. For internal use only. | |
| constexpr void | setGeneration (uint16_t generation) |
| Sets the component generation. | |
| constexpr uint16_t | getGeneration () const |
| Gets the component generation. | |
| size_t | hash (size_t hashValue=Cogs::hash()) const |
| Calculates a hash of this component's members. | |
Detailed Description
Definition at line 49 of file CaptureComponent.h.
Member Function Documentation
◆ registerType()
|
static |
Definition at line 7 of file CaptureComponent.cpp.
Member Data Documentation
◆ dropFrames
| bool Cogs::Core::CaptureComponent::dropFrames = true |
Allow capture to drop frames.
If capture gets a new frame before the previous frame is finished, we can either (dropFrames=true) just drop the new frame, or stall the application until we can process the new frame (dropFrames=false).
Definition at line 87 of file CaptureComponent.h.
◆ format
| CaptureFormat Cogs::Core::CaptureComponent::format = CaptureFormat::PNG |
Specifices the format of the captured data.
Definition at line 71 of file CaptureComponent.h.
◆ framesToCapture
| int Cogs::Core::CaptureComponent::framesToCapture = 0 |
Enable capture for the given number of frames.
Is automatically decremented each frame. Set to negative value to always capture.
Definition at line 78 of file CaptureComponent.h.
◆ mode
| CaptureMode Cogs::Core::CaptureComponent::mode = CaptureMode::Scene |
Specify type of capture.
Typically managed by code that requests capture.
Definition at line 56 of file CaptureComponent.h.
◆ recordPath
| std::string Cogs::Core::CaptureComponent::recordPath |
Path to directory where captured frames are stored.
Definition at line 100 of file CaptureComponent.h.
◆ recordToDisc
| bool Cogs::Core::CaptureComponent::recordToDisc = false |
Write capture frames to disc.
In addition to making captured frames available to the application, store new frames to disc.
- See also
- recordPath.
Definition at line 95 of file CaptureComponent.h.
◆ sceneMode
| CaptureSceneMode Cogs::Core::CaptureComponent::sceneMode = CaptureSceneMode::Forward |
Specify rendering mode when mode is scene.
Scene-mode is typically scene-dependent set on a scene-by-scene basis.
Definition at line 63 of file CaptureComponent.h.
◆ size
| glm::vec2 Cogs::Core::CaptureComponent::size |
Definition at line 66 of file CaptureComponent.h.
The documentation for this struct was generated from the following files:
- Source/Components/Core/CaptureComponent.h
- Source/Components/Core/CaptureComponent.cpp
