Inheritance diagram for Cogs::Core::VideoPlaybackComponent:
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 | |
| VideoDecoderDescription | description |
| std::string | source |
| Cogs::Core::TextureHandle | texture = Cogs::Core::TextureHandle::NoHandle |
| bool | reconfig = false |
| bool | restart = false |
| bool | recordToDisk = false |
| Write video frames to disk. | |
| std::string | recordPath |
| Path to directory where captured video is stored. | |
| VideoDecoderCallback * | decodeCallback = nullptr |
| void * | decodeCallbackData = nullptr |
| VideoPresentCallback * | presentCallback = nullptr |
| void * | presentCallbackData = nullptr |
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 10 of file VideoPlaybackComponent.h.
Member Function Documentation
◆ registerType()
|
static |
Definition at line 7 of file VideoPlaybackComponent.cpp.
Member Data Documentation
◆ decodeCallback
| VideoDecoderCallback* Cogs::Core::VideoPlaybackComponent::decodeCallback = nullptr |
Definition at line 34 of file VideoPlaybackComponent.h.
◆ decodeCallbackData
| void* Cogs::Core::VideoPlaybackComponent::decodeCallbackData = nullptr |
Definition at line 35 of file VideoPlaybackComponent.h.
◆ description
| VideoDecoderDescription Cogs::Core::VideoPlaybackComponent::description |
Definition at line 12 of file VideoPlaybackComponent.h.
◆ presentCallback
| VideoPresentCallback* Cogs::Core::VideoPlaybackComponent::presentCallback = nullptr |
Definition at line 40 of file VideoPlaybackComponent.h.
◆ presentCallbackData
| void* Cogs::Core::VideoPlaybackComponent::presentCallbackData = nullptr |
Definition at line 41 of file VideoPlaybackComponent.h.
◆ reconfig
| bool Cogs::Core::VideoPlaybackComponent::reconfig = false |
Definition at line 18 of file VideoPlaybackComponent.h.
◆ recordPath
| std::string Cogs::Core::VideoPlaybackComponent::recordPath |
Path to directory where captured video is stored.
Definition at line 29 of file VideoPlaybackComponent.h.
◆ recordToDisk
| bool Cogs::Core::VideoPlaybackComponent::recordToDisk = false |
Write video frames to disk.
Definition at line 24 of file VideoPlaybackComponent.h.
◆ restart
| bool Cogs::Core::VideoPlaybackComponent::restart = false |
Definition at line 19 of file VideoPlaybackComponent.h.
◆ source
| std::string Cogs::Core::VideoPlaybackComponent::source |
Definition at line 14 of file VideoPlaybackComponent.h.
◆ texture
| Cogs::Core::TextureHandle Cogs::Core::VideoPlaybackComponent::texture = Cogs::Core::TextureHandle::NoHandle |
Definition at line 16 of file VideoPlaybackComponent.h.
The documentation for this struct was generated from the following files:
- Extensions/Video/VideoPlaybackComponent.h
- Extensions/Video/VideoPlaybackComponent.cpp
