package applier

import (
	"context"

	v2 "edge-infra.dev/pkg/sds/display/k8s/apis/v2"
)

// A DisplayApplier is able to take a DisplayConfig and apply the display
// configuration to the host node, e.g. by updating the xorg.conf file with
// the configuration detailed by the DisplayConfig.
//
// The relevant display manager (e.g. Xorg) must be running to be able to apply
// the display configuration to the node. See manager.DisplayManager.
type DisplayApplier interface {
	// Apply takes display configuration for the node represented as a
	// DisplayConfig and applies it to the display manager.
	//
	// The applied DisplayConfig is returned, with any specified input or
	// display devices which were not present removed.
	Apply(context.Context, *v2.DisplayConfig) (*v2.DisplayConfig, error)
}