context.go

// Copyright (C) 2017 Google Inc.
//
// 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
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package api

import (
	"reflect"

	"github.com/google/gapid/core/data/id"
	"github.com/google/gapid/gapis/service/path"
)

// ContextID is the unique identifier for a context.
type ContextID id.ID

// Context represents a graphics API's unique context of execution.
type Context interface {
	APIObject

	// ID returns the context's unique identifier
	ID() ContextID
}

// ContextInfo is describes a Context.
// Unlike Context, ContextInfo describes the context at no particular point in
// the trace.
type ContextInfo struct {
	Path              *path.Context
	ID                ContextID
	API               ID
	NumCommandsByType map[reflect.Type]int
	Name              string
	Priority          int
	UserData          map[interface{}]interface{}
}