katra-core 0.1.0

Katra3D core: shared vocabulary, error model, event model, IDs, and policy types.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

//! katra-core — the shared vocabulary of Katra3D.
//!
//! Every other crate builds on the types defined here so that the semantic
//! request graph, the trace format, the profiler, the reporters, and the
//! runtime subsystems can cooperate directly without FFI boundaries.
//!
//! This crate intentionally contains **no unsafe code** and **no I/O**.
//! It is the vocabulary, the error model, and the policy types.
//!
//! # Format stability discipline
//!
//! Several types here are serialized into the Katra trace format
//! (`katra-trace`). Enum layouts are serialized by variant index, therefore:
//!
//! * **Append-only evolution**: new enum variants must be appended at the end.
//! * Any layout-affecting change must bump the trace format version and/or the
//!   schema hash (see `katra-trace::header`).

#![forbid(unsafe_code)]
#![warn(missing_docs)]

pub mod config;
pub mod deadline;
pub mod error;
pub mod event;
pub mod hash;
pub mod ids;
pub mod kind;
pub mod payload;
pub mod scope;
pub mod subsystem;
pub mod time;
pub mod version;

pub use config::{CaptureOptions, HardwareProfile};
pub use deadline::DeadlineClass;
pub use error::{ErrorCategory, KatraError, Result};
pub use event::{EmitOpts, TraceEvent};
pub use hash::{fnv1a, fnv1a_combine, fnv1a_parts, fnv1a_str};
pub use ids::{AllocId, ArenaId, Epoch, FileKey, OpId, RequestId, ResourceRef, Seq, SpanId};
pub use kind::{D3d12Call, EventKind, Phase, VulkanCall};
pub use payload::{
    CachePayload, D3d12Payload, DecompressPayload, FilePayload, GpuPayload, IoPayload,
    KatraPayload, MemPayload, Payload, PresentPayload, RawPayload, ShaderPayload, SyncPayload,
    ThreadPayload, VulkanPayload,
};
pub use scope::Scope;
pub use subsystem::{PromotionState, Subsystem};
pub use time::{monotonic_now_ns, wall_now_ns};
pub use version::KATRA_VERSION;