layout: doc title: “Starboard Module Reference: configuration.h”

Provides a description of the current platform in lurid detail so that common code never needs to actually know what the current operating system and architecture are.
It is both very pragmatic and canonical in that if any application code finds itself needing to make a platform decision, it should always define a Starboard Configuration feature instead. This implies the continued existence of very narrowly-defined configuration features, but it retains porting control in Starboard.

Macros

Specifies the alignment for a class, struct, union, enum, class/struct field, or stack variable.

Note that this macro's definition varies depending on the values of one or more other variables.

Returns the alignment reqiured for any instance of the type indicated by type.

Note that this macro's definition varies depending on the values of one or more other variables.

A constant expression that evaluates to the size_t size of a statically-sized array.

A constant expression that evaluates to the int size of a statically-sized array.

Note that this macro's definition varies depending on the values of one or more other variables.

Determines a compile-time capability of the system.

Specifies whether the starboard media pipeline components (SbPlayerPipeline and StarboardDecryptor) are used. Set to 0 means they are not used.

Note that this macro's definition varies depending on the values of one or more other variables.

SB_DEPRECATED(int Foo(int bar)); Annotates the function as deprecated, which will trigger a compiler warning when referenced.

Note that this macro's definition varies depending on the values of one or more other variables.

SB_DEPRECATED_EXTERNAL(...) annotates the function as deprecated for external clients, but not deprecated for starboard.

Note that this macro's definition varies depending on the values of one or more other variables.

A macro to disallow the copy constructor and operator= functions This should be used in the private: declarations for a class

The API version that is currently open for changes, and therefore is not stable or frozen. Production-oriented ports should avoid declaring that they implement the experimental Starboard API version.

Whether we use PRETTY_FUNCTION or FUNCTION for logging.

Note that this macro's definition varies depending on the values of one or more other variables.

Determines at compile-time whether this platform has a standard feature or header available.

Whether the current platform has 64-bit atomic operations.

Note that this macro's definition varies depending on the values of one or more other variables.

Specifies whether this platform has a performant OpenGL ES 2 implementation, which allows client applications to use GL rendering paths. Derived from the gyp variable ‘gl_type’ which indicates what kind of GL implementation is available.

Specifies whether this platform has any kind of supported graphics system.

Note that this macro's definition varies depending on the values of one or more other variables.

Determines at compile-time whether this platform has a quirk.

Declare numeric literals of signed 64-bit type.

Note that this macro's definition varies depending on the values of one or more other variables.

Determines at compile-time an inherent aspect of this platform.

Whether the current platform is little endian.

Note that this macro's definition varies depending on the values of one or more other variables.

Macro for hinting that an expression is likely to be true.

Note that this macro's definition varies depending on the values of one or more other variables.

The maximum API version allowed by this version of the Starboard headers, inclusive.

The minimum API version allowed by this version of the Starboard headers, inclusive.

EXAMPLE: // Introduce new experimental feature. // Add a function, SbMyNewFeature() to starboard/feature.h which // exposes functionality for my new feature.

Macro to annotate a function as noreturn, which signals to the compiler that the function cannot return.

Note that this macro's definition varies depending on the values of one or more other variables.

Declares a function as overriding a virtual function on compilers that support it.

Note that this macro's definition varies depending on the values of one or more other variables.

An enumeration of values for the SB_PREFERRED_RGBA_BYTE_ORDER configuration variable. Setting this up properly means avoiding slow color swizzles when passing pixel data from one library to another. Note that these definitions are in byte-order and so are endianness-independent.

An enumeration of values for the SB_PREFERRED_RGBA_BYTE_ORDER configuration variable. Setting this up properly means avoiding slow color swizzles when passing pixel data from one library to another. Note that these definitions are in byte-order and so are endianness-independent.

An enumeration of values for the SB_PREFERRED_RGBA_BYTE_ORDER configuration variable. Setting this up properly means avoiding slow color swizzles when passing pixel data from one library to another. Note that these definitions are in byte-order and so are endianness-independent.

Tells the compiler a function is using a printf-style format string. format_param is the one-based index of the format string parameter; dots_param is the one-based index of the “...” parameter. For v*printf functions (which take a va_list), pass 0 for dots_param. (This is undocumented but matches what the system C headers do.) (Partially taken from base/compiler_specific.h)

The next API version to be frozen, but is still subject to emergency changes. It is reasonable to base a port on the Release Candidate API version, but be aware that small incompatible changes may still be made to it. The following will be uncommented when an API version is a release candidate.

Makes a pointer-typed parameter restricted so that the compiler can make certain optimizations because it knows the pointers are unique.

Note that this macro's definition varies depending on the values of one or more other variables.

Standard CPP trick to stringify an evaluated macro definition.

Standard CPP trick to stringify an evaluated macro definition.

Declare numeric literals of unsigned 64-bit type.

Note that this macro's definition varies depending on the values of one or more other variables.

Macro for hinting that an expression is likely to be false.

Note that this macro's definition varies depending on the values of one or more other variables.

Trivially references a parameter that is otherwise unreferenced, preventing a compiler warning on some platforms.

Note that this macro's definition varies depending on the values of one or more other variables.

Causes the annotated (at the end) function to generate a warning if the result is not accessed.