macos

Documentation

Index

• Variables
• func NewAppBundleAction(rc *run.Context, artifacts []string) action.WithDescription[action.Function]
• type Target
  • func (t *Target) Collect(rc *run.Context, tl *template.Template, ev engine.Version) *export.Export
  • func (t *Target) Configure(rc *run.Context) error
  • func (t *Target) MergeInto(other any) error
  • func (t *Target) Validate(rc *run.Context) error
• type TargetWithFeaturesAndProfile
  • func (t *TargetWithFeaturesAndProfile) Build(rc *run.Context, dst *Target) error
• type TargetWithProfile
• type Template
  • func (t *Template) Collect(g engine.Source, rc *run.Context) *template.Template
  • func (t *Template) Configure(rc *run.Context) error
  • func (t *Template) MergeInto(other any) error
  • func (t *Template) Validate(rc *run.Context) error
• type TemplateWithFeaturesAndProfile
  • func (t *TemplateWithFeaturesAndProfile) Build(rc *run.Context, dst *Template) error
• type TemplateWithProfile
• type Vulkan
  • func (c *Vulkan) Configure(rc *run.Context) error
  • func (c *Vulkan) Validate(_ *run.Context) error

Variables

var ErrInvalidInput = errors.New("invalid input")

var ErrMissingInput = errors.New("missing input")

Functions

func NewAppBundleAction

func NewAppBundleAction(
	rc *run.Context,
	artifacts []string,
) action.WithDescription[action.Function]

NewAppBundleAction creates an 'action.Action' which generates an app bundle from the specified export templates.

Types

type Target

type Target struct {
	*common.Target

	// PathIcon is a path to a Windows application icon.
	BundleIdentifier string `toml:"bundle_identifier"`
}

func (*Target) Collect

func (t *Target) Collect(rc *run.Context, tl *template.Template, ev engine.Version) *export.Export

func (*Target) Configure

func (t *Target) Configure(rc *run.Context) error

func (*Target) MergeInto

func (t *Target) MergeInto(other any) error

func (*Target) Validate

func (t *Target) Validate(rc *run.Context) error

type TargetWithFeaturesAndProfile

type TargetWithFeaturesAndProfile struct {
	*Target

	Feature map[string]TargetWithProfile `toml:"feature"`
	Profile map[engine.Profile]Target    `toml:"profile"`
}

func (*TargetWithFeaturesAndProfile) Build

func (t *TargetWithFeaturesAndProfile) Build(rc *run.Context, dst *Target) error

type TargetWithProfile

type TargetWithProfile struct {
	*Target

	Profile map[engine.Profile]Target `toml:"profile"`
}

type Template

type Template struct {
	*common.Template

	// LipoCommand contains arguments used to invoke 'lipo'. Defaults to
	// ["lipo"]. Only used if 'arch' is set to 'platform.ArchUniversal'.
	LipoCommand []string `toml:"lipo_command"`

	// Vulkan defines Vulkan-related configuration.
	Vulkan Vulkan `toml:"vulkan"`
}

func (*Template) Collect

func (t *Template) Collect(g engine.Source, rc *run.Context) *template.Template

func (*Template) Configure

func (t *Template) Configure(rc *run.Context) error

func (*Template) MergeInto

func (t *Template) MergeInto(other any) error

func (*Template) Validate

func (t *Template) Validate(rc *run.Context) error

type TemplateWithFeaturesAndProfile

type TemplateWithFeaturesAndProfile struct {
	*Template

	Feature map[string]TemplateWithProfile `toml:"feature"`
	Profile map[engine.Profile]Template    `toml:"profile"`
}

func (*TemplateWithFeaturesAndProfile) Build

func (t *TemplateWithFeaturesAndProfile) Build(rc *run.Context, dst *Template) error

type TemplateWithProfile

type TemplateWithProfile struct {
	*Template

	Profile map[engine.Profile]Template `toml:"profile"`
}

type Vulkan

type Vulkan struct {
	// Dynamic enables dynamically linking Vulkan to the template.
	Dynamic *bool `toml:"use_volk"`

	// PathSDK is the path to the Vulkan SDK root.
	PathSDK osutil.Path `toml:"sdk_path"`
}

Vulkan defines the settings required by the MacOS template for including Vulkan support.

func (*Vulkan) Configure

func (c *Vulkan) Configure(rc *run.Context) error

func (*Vulkan) Validate

func (c *Vulkan) Validate(_ *run.Context) error