RealDocs

UActorComponent::IsRenderStateDirty

function Engine Since 4.0
#include "Components/ActorComponent.h"
Access: public Specifiers: inline

Description

Returns true if the full render state for this component is dirty, meaning the scene proxy needs to be fully recreated or updated on the render thread.

Caveats & Gotchas

  • A dirty render state means the component's entire scene proxy data will be re-sent, which is more expensive than a dynamic-data or instance-only update. If you only changed dynamic properties, call MarkRenderDynamicDataDirty instead.
  • This flag is read by DoDeferredRenderUpdates_Concurrent — do not call DoDeferredRenderUpdates_Concurrent directly; let the engine invoke it at the end of frame.

Signature

inline bool IsRenderStateDirty() const

Return Type

bool

Example

Checking before issuing a redundant mark C++
// Avoid marking dirty again if already pending
if (!MyComponent->IsRenderStateDirty())
{
	MyComponent->MarkRenderStateDirty();
}

Version History

Introduced in: 4.0

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.