Cogs.Core
Static Public Member Functions | Public Attributes | List of all members
Cogs::Core::VideoCaptureComponent Struct Reference
Inheritance diagram for Cogs::Core::VideoCaptureComponent:
Cogs::ComponentModel::Component

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

Codec codec = Codec::H264
 
H264Profile profile = H264Profile::High
 
H264Preset preset = H264Preset::HighQuality
 
BFrameReference bFrameReference = BFrameReference::Middle
 
uint32_t width = 1920
 
uint32_t height = 1080
 
uint32_t maxWidth = 3840
 
uint32_t maxHeight = 2160
 
uint32_t bitrate = 6000000
 
uint32_t maxBitrate = 10000000
 
uint32_t frameInterval = 15
 
uint32_t bFrameCount = 2
 
bool lookahead = true
 
bool updateTimestamp = true
 
bool reconfig = false
 
bool restart = false
 
bool useMSAA = false
 
uint64_t timestamp = 0
 Capture state.
 
uint64_t duration = 0
 
bool forceIntra = false
 
bool forceIDR = false
 
bool outputSPSPPS = false
 
bool endOfStream = false
 
bool recordToDisk = false
 Write video frames to disk.
 
std::string recordPath
 Path to directory where captured video is stored.
 
VideoEncoderCallback callback
 

Additional Inherited Members

- Public Member Functions inherited from Cogs::ComponentModel::Component
class EntitygetContainer () 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 ComponentgetComponent (const Reflection::Name &name) const
 
COGSFOUNDATION_API ComponentgetComponent (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::TypegetType () 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 35 of file VideoCaptureComponent.h.

Member Function Documentation

◆ registerType()

void Cogs::Core::VideoCaptureComponent::registerType ( )
static

Definition at line 7 of file VideoCaptureComponent.cpp.

Member Data Documentation

◆ bFrameCount

uint32_t Cogs::Core::VideoCaptureComponent::bFrameCount = 2

Definition at line 51 of file VideoCaptureComponent.h.

◆ bFrameReference

BFrameReference Cogs::Core::VideoCaptureComponent::bFrameReference = BFrameReference::Middle

Definition at line 40 of file VideoCaptureComponent.h.

◆ bitrate

uint32_t Cogs::Core::VideoCaptureComponent::bitrate = 6000000

Definition at line 47 of file VideoCaptureComponent.h.

◆ callback

VideoEncoderCallback Cogs::Core::VideoCaptureComponent::callback

Definition at line 83 of file VideoCaptureComponent.h.

◆ codec

Codec Cogs::Core::VideoCaptureComponent::codec = Codec::H264

Definition at line 37 of file VideoCaptureComponent.h.

◆ duration

uint64_t Cogs::Core::VideoCaptureComponent::duration = 0

Definition at line 64 of file VideoCaptureComponent.h.

◆ endOfStream

bool Cogs::Core::VideoCaptureComponent::endOfStream = false

Definition at line 68 of file VideoCaptureComponent.h.

◆ forceIDR

bool Cogs::Core::VideoCaptureComponent::forceIDR = false

Definition at line 66 of file VideoCaptureComponent.h.

◆ forceIntra

bool Cogs::Core::VideoCaptureComponent::forceIntra = false

Definition at line 65 of file VideoCaptureComponent.h.

◆ frameInterval

uint32_t Cogs::Core::VideoCaptureComponent::frameInterval = 15

Definition at line 49 of file VideoCaptureComponent.h.

◆ height

uint32_t Cogs::Core::VideoCaptureComponent::height = 1080

Definition at line 43 of file VideoCaptureComponent.h.

◆ lookahead

bool Cogs::Core::VideoCaptureComponent::lookahead = true

Definition at line 53 of file VideoCaptureComponent.h.

◆ maxBitrate

uint32_t Cogs::Core::VideoCaptureComponent::maxBitrate = 10000000

Definition at line 48 of file VideoCaptureComponent.h.

◆ maxHeight

uint32_t Cogs::Core::VideoCaptureComponent::maxHeight = 2160

Definition at line 45 of file VideoCaptureComponent.h.

◆ maxWidth

uint32_t Cogs::Core::VideoCaptureComponent::maxWidth = 3840

Definition at line 44 of file VideoCaptureComponent.h.

◆ outputSPSPPS

bool Cogs::Core::VideoCaptureComponent::outputSPSPPS = false

Definition at line 67 of file VideoCaptureComponent.h.

◆ preset

H264Preset Cogs::Core::VideoCaptureComponent::preset = H264Preset::HighQuality

Definition at line 39 of file VideoCaptureComponent.h.

◆ profile

H264Profile Cogs::Core::VideoCaptureComponent::profile = H264Profile::High

Definition at line 38 of file VideoCaptureComponent.h.

◆ reconfig

bool Cogs::Core::VideoCaptureComponent::reconfig = false

Definition at line 56 of file VideoCaptureComponent.h.

◆ recordPath

std::string Cogs::Core::VideoCaptureComponent::recordPath

Path to directory where captured video is stored.

Definition at line 78 of file VideoCaptureComponent.h.

◆ recordToDisk

bool Cogs::Core::VideoCaptureComponent::recordToDisk = false

Write video frames to disk.

Definition at line 73 of file VideoCaptureComponent.h.

◆ restart

bool Cogs::Core::VideoCaptureComponent::restart = false

Definition at line 57 of file VideoCaptureComponent.h.

◆ timestamp

uint64_t Cogs::Core::VideoCaptureComponent::timestamp = 0

Capture state.

Definition at line 63 of file VideoCaptureComponent.h.

◆ updateTimestamp

bool Cogs::Core::VideoCaptureComponent::updateTimestamp = true

Definition at line 55 of file VideoCaptureComponent.h.

◆ useMSAA

bool Cogs::Core::VideoCaptureComponent::useMSAA = false

Definition at line 58 of file VideoCaptureComponent.h.

◆ width

uint32_t Cogs::Core::VideoCaptureComponent::width = 1920

Definition at line 42 of file VideoCaptureComponent.h.


The documentation for this struct was generated from the following files: