Introducing Google AI Edge Portal: Benchmark Edge AI at scale. Sign-up to request access during private preview.

litert::Environment

#include <litert_environment.h>

The environment works like a context that holds the runtime states.

Summary

To create a CompiledModel or TensorBuffer, an Environment is required. In a case of having multiple CompiledModels, it is recommended to share the same Environment.

Public functions
`Get() const noexcept`	`LiteRtEnvironment`
`GetHolder() const noexcept`	`internal::EnvironmentHolder`
`GetOptions() const`	`Expected< EnvironmentOptions >`
`Release() noexcept`	`internal::EnvironmentHolder`
`SupportsAhwbClInterop() const`	`bool` Returns whether the environment supports AHWB/CL interop.
`SupportsAhwbGlInterop() const`	`bool` Returns whether the environment supports AHWB/GL interop.
`SupportsClGlInterop() const`	`bool` Returns whether the environment supports CL/GL interop.
`deprecated("Use EnvironmentOptions::Tag instead.")]] OptionTag`	`enum`
`deprecated("Use EnvironmentOptions::Option instead.")]] Option`	`struct`
`operator bool() const noexcept`	Returns `true` if the underlying LiteRT handle is valid.
`operator!=(const Environment & other) const noexcept`	`bool`
`operator==(const Environment & other) const noexcept`	`bool`

Public static functions
`Create(absl::Span< const Option > options)`	`Expected< Environment >`
`Create(const EnvironmentOptions & options)`	`Expected< Environment >`
`WrapCObject(LiteRtEnvironment env, OwnHandle owned)`	`Environment`
`WrapCObject(const internal::EnvironmentHolder & env, OwnHandle owned)`	`Environment`

LiteRtEnvironment Get() const noexcept

internal::EnvironmentHolder GetHolder() const noexcept

Expected< EnvironmentOptions > GetOptions() const

internal::EnvironmentHolder Release() noexcept

bool SupportsAhwbClInterop() const

Returns whether the environment supports AHWB/CL interop.

bool SupportsAhwbGlInterop() const

Returns whether the environment supports AHWB/GL interop.

bool SupportsClGlInterop() const

Returns whether the environment supports CL/GL interop.

enum deprecated(
  "Use EnvironmentOptions::Tag instead."
)]] OptionTag

struct deprecated(
  "Use EnvironmentOptions::Option instead."
)]] Option

 operator bool() const noexcept

Returns true if the underlying LiteRT handle is valid.

bool operator!=(
  const Environment & other
) const noexcept

bool operator==(
  const Environment & other
) const noexcept

Expected< Environment > Create(
  absl::Span< const Option > options
)

Expected< Environment > Create(
  const EnvironmentOptions & options
)

Environment WrapCObject(
  LiteRtEnvironment env,
  OwnHandle owned
)

Environment WrapCObject(
  const internal::EnvironmentHolder & env,
  OwnHandle owned
)