blob: a388d7c05f0fec629daec4569aaef8fc63c08f22 [file] [log] [blame]
// Copyright (C) 2015 The Android Open Source Project
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
// Package atom provides the fundamental types used to describe a capture stream.
package atom
import ""
// Atom is the interface implemented by all objects that describe an single
// event in a capture stream. Typical implementations of Atom describe an
// application's call to a graphics API function or provide meta-data describing
// observed memory or state at the time of capture.
// Each Atom instance is assigned a ContextId. The meaning of this identifier
// is API dependent, but is typically used to identify which thread or rendering
// context the atom belongs to. For example the ContextId is used to associate
// atoms of the same GLES context together.
// Each implementation of Atom should have a unique and stable TypeId to ensure
// binary compatibility with old capture formats. Any change to the Atom's
// binary format should also result in a new TypeId.
type Atom interface {
TypeId() TypeId
ContextId() ContextId
Flags() Flags
Encode(*binary.Encoder) error
Decode(*binary.Decoder) error