Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::render::SkpCaptureResult Struct Reference

Outcome of a .skp capture attempt. More...

#include <skp_capture.hpp>

Public Member Functions

 operator bool () const

Public Attributes

bool ok = false
 True when a .skp artifact was produced.
std::string path
 Filesystem path of the written .skp, when ok.
std::size_t bytes_written = 0
 Size of the serialized .skp blob.
std::size_t op_count = 0
 Approximate recorded draw-op count.
std::string reason
 Failure explanation when !ok.

Detailed Description

Outcome of a .skp capture attempt.

A capture either produces a valid .skp artifact (ok == true, bytes_written > 0) or fails with a human-readable reason — never a half-written file.

Member Function Documentation

◆ operator bool()

pulp::render::SkpCaptureResult::operator bool ( ) const
inlineexplicit

Member Data Documentation

◆ bytes_written

std::size_t pulp::render::SkpCaptureResult::bytes_written = 0

Size of the serialized .skp blob.

◆ ok

bool pulp::render::SkpCaptureResult::ok = false

True when a .skp artifact was produced.

◆ op_count

std::size_t pulp::render::SkpCaptureResult::op_count = 0

Approximate recorded draw-op count.

◆ path

std::string pulp::render::SkpCaptureResult::path

Filesystem path of the written .skp, when ok.

◆ reason

std::string pulp::render::SkpCaptureResult::reason

Failure explanation when !ok.


The documentation for this struct was generated from the following file:
  • /home/runner/work/pulp/pulp/core/render/include/pulp/render/skp_capture.hpp