impeller::CaptureContext Class Reference

#include <capture.h>

Public Member Functions
	CaptureContext ()
bool	IsActive () const
void	Rewind ()
Capture	GetDocument (const std::string &label)
bool	DoesDocumentExist (const std::string &label) const

Static Public Member Functions
static CaptureContext	MakeInactive ()
static CaptureContext	MakeAllowlist (std::initializer_list< std::string > allowlist)

Detailed Description

Definition at line 269 of file capture.h.

Constructor & Destructor Documentation

CaptureContext()

impeller::CaptureContext::CaptureContext

(

)

CaptureContext

Definition at line 149 of file capture.cc.

{}

Referenced by MakeAllowlist(), and MakeInactive().

Member Function Documentation

DoesDocumentExist()

bool impeller::CaptureContext::DoesDocumentExist

(

const std::string &

label

)

const

Definition at line 209 of file capture.cc.

                                                                   {
#ifdef IMPELLER_ENABLE_CAPTURE
  if (!active_) {
    return false;
  }
  return documents_.find(label) != documents_.end();
#else
  return false;
#endif
}

GetDocument()

Capture impeller::CaptureContext::GetDocument

(

const std::string &

label

)

Definition at line 182 of file capture.cc.

                                                          {
#ifdef IMPELLER_ENABLE_CAPTURE
  if (!active_) {
    return Capture::MakeInactive();
  }
 
  if (allowlist_.has_value()) {
    if (allowlist_->find(label) == allowlist_->end()) {
      return Capture::MakeInactive();
    }
  }
 
  auto found = documents_.find(label);
  if (found != documents_.end()) {
    // Always rewind when fetching an existing document.
    found->second.Rewind();
    return found->second;
  }
 
  auto new_document = Capture(label);
  documents_.emplace(label, new_document);
  return new_document;
#else
  return Capture::MakeInactive();
#endif
}

References impeller::Capture::MakeInactive().

IsActive()

bool impeller::CaptureContext::IsActive

(

)

const

Definition at line 164 of file capture.cc.

                                    {
#ifdef IMPELLER_ENABLE_CAPTURE
  return active_;
#else
  return false;
#endif
}

MakeAllowlist()

CaptureContext impeller::CaptureContext::MakeAllowlist ( std::initializer_list< std::string >  allowlist )

static

Definition at line 159 of file capture.cc.

                                              {
  return CaptureContext(allowlist);
}

References CaptureContext().

Referenced by impeller::AiksInspector::RenderInspector(), and impeller::testing::TEST_P().

MakeInactive()

CaptureContext impeller::CaptureContext::MakeInactive ( )

static

Definition at line 155 of file capture.cc.

                                            {
  return CaptureContext(InactiveFlag{});
}

References CaptureContext().

Referenced by impeller::AiksInspector::RenderInspector().

Rewind()

void impeller::CaptureContext::Rewind

(

)

Definition at line 172 of file capture.cc.

                            {
#ifdef IMPELLER_ENABLE_CAPTURE
  for (auto& [name, capture] : documents_) {
    capture.GetElement()->Rewind();
  }
#else
  return;
#endif
}

---

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

• impeller/core/capture.h
• impeller/core/capture.cc