Skip to main content

apple_metal_library

An apple_metal_library() rule contains .metal and .h source files to be bundled together to create a .metallib

Function Signature​

def apple_metal_library(
    *,
    name: str,
    default_target_platform: None | str = None,
    target_compatible_with: list[str] = [],
    compatible_with: list[str] = [],
    exec_compatible_with: list[str] = [],
    visibility: list[str] = [],
    within_view: list[str] = ["PUBLIC"],
    metadata: OpaqueMetadata = {},
    tests: list[str] = [],
    modifiers: OpaqueMetadata = [],
    _apple_platforms: dict[str, str] = {},
    _apple_toolchain: str = "gh_facebook_buck2_shims_meta//:apple-resources",
    headers: list[str] = [],
    labels: list[str] = [],
    metal_compiler_flags: list[str] = [],
    metal_linker_flags: list[str] = [],
    metal_version: None | str = None,
    out: None | str = None,
    srcs: list[str] = [],
) -> None

Parameters​

  • name: (required)

    name of the target

  • default_target_platform: (defaults to: None)

    specifies the default target platform, used when no platforms are specified on the command line

  • target_compatible_with: (defaults to: [])

    a list of constraints that are required to be satisfied for this target to be compatible with a configuration

  • compatible_with: (defaults to: [])

    a list of constraints that are required to be satisfied for this target to be compatible with a configuration

  • exec_compatible_with: (defaults to: [])

    a list of constraints that are required to be satisfied for this target to be compatible with an execution platform

  • visibility: (defaults to: [])

    a list of visibility patterns restricting what targets can depend on this one

  • within_view: (defaults to: ["PUBLIC"])

    a list of visibility patterns restricting what this target can depend on

  • metadata: (defaults to: {})

    a key-value map of metadata associated with this target

  • tests: (defaults to: [])

    a list of targets that provide tests for this one

  • modifiers: (defaults to: [])

    an array of modifiers associated with this target

  • metal_compiler_flags: (defaults to: [])

    Flags to use when compiling Metal sources.

  • metal_linker_flags: (defaults to: [])

    Flags to use when linking Metal .air files using metallib.

  • out: (defaults to: None)

    The name of the compiled library (must end in .metallib). Defaults to the target's name.

Examples​



apple_metal_library(
  name = 'MyShaderLibrary',
  srcs = [
      MyShaderFile.metal,
      SharedShaderHelpers.metal,
  ],
  headers = [ SharedShaderHelpers.h ],
)