All docs
lsdtools.exports reference
Generated public SDK reference for lsdtools.exports.
SDK distribution 1.0.0; API contract 1.0; generator 1.0.0.
Product source digest: 4ea39055732e8883c03ccfecf12af6ccebd2041a12ce1b843e4a769e200f5ef9.
Generated from declared public exports and source syntax. Signatures and annotations are declaration spellings; decorators, factories and annotations are never executed. Class members below are declared members; base classes remain explicit. Source docstrings describe their owning implementation; they do not grant app permissions.
Lazy public API for package-owned native application export recipes and windows.
lsdtools.exports.ExportField#
Kind: class. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:29.
Implementation alias: lsd_export_desktop.platforms.ExportField.
lsdtools.exports.ExportField.id#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:30.
id: str
lsdtools.exports.ExportField.label#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:31.
label: str
lsdtools.exports.ExportField.kind#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:32.
kind: str
kind = 'text'
lsdtools.exports.ExportField.default#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:33.
default: object
default = ''
lsdtools.exports.ExportField.help#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:34.
help: str
help = ''
lsdtools.exports.ExportField.choices#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:35.
choices: tuple[str, ...]
choices = ()
lsdtools.exports.ExportField.minimum#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:36.
minimum: float | None
minimum = None
lsdtools.exports.ExportField.maximum#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:37.
maximum: float | None
maximum = None
lsdtools.exports.ExportField.validate#
Kind: method. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:48.
validate(self, value)
self: (unannotated)
value: (unannotated)
lsdtools.exports.ExportPlatform#
Kind: class. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:126.
Implementation alias: lsd_export_desktop.platforms.ExportPlatform.
lsdtools.exports.ExportPlatform.id#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:127.
id: str
lsdtools.exports.ExportPlatform.label#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:128.
label: str
lsdtools.exports.ExportPlatform.description#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:129.
description: str
lsdtools.exports.ExportPlatform.fields#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:130.
fields: tuple[ExportField, ...]
lsdtools.exports.ExportPlatform.presets#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:131.
presets: tuple[ExportPreset, ...]
lsdtools.exports.ExportPlatform.make_recipe#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:132.
make_recipe: Callable[[Mapping], ExportRecipe]
lsdtools.exports.ExportPlatform.resolve#
Kind: method. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:146.
resolve(self, settings=None, preset=None)
preset: (unannotated)
self: (unannotated)
settings: (unannotated)
lsdtools.exports.ExportPreset#
Kind: class. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:66.
Implementation alias: lsd_export_desktop.platforms.ExportPreset.
lsdtools.exports.ExportPreset.id#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:67.
id: str
lsdtools.exports.ExportPreset.label#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:68.
label: str
lsdtools.exports.ExportPreset.values#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:69.
values: Mapping
values = field(default_factory=dict)
lsdtools.exports.ExportRecipe#
Kind: class. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:77.
Implementation alias: lsd_export_desktop.platforms.ExportRecipe.
lsdtools.exports.ExportRecipe.target#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:78.
target: str
lsdtools.exports.ExportRecipe.source_only#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:79.
source_only: bool
source_only = True
lsdtools.exports.ExportRecipe.headless#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:80.
headless: bool
headless = True
lsdtools.exports.ExportRecipe.compiler#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:81.
compiler: str | Path | None
compiler = None
lsdtools.exports.ExportRecipe.application_name#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:82.
application_name: str
application_name = 'LSD Application'
lsdtools.exports.ExportRecipe.fixed_hz#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:83.
fixed_hz: float
fixed_hz = 60
lsdtools.exports.ExportRecipe.substeps#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:84.
substeps: int
substeps = 4
lsdtools.exports.ExportRecipe.width#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:85.
width: int
width = 1280
lsdtools.exports.ExportRecipe.height#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:86.
height: int
height = 720
lsdtools.exports.ExportRecipe.frames#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:87.
frames: int
frames = 600
lsdtools.exports.ExportRecipe.physics_workers#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:88.
physics_workers: int
physics_workers = 0
lsdtools.exports.ExportRecipe.files#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:89.
files: Mapping[str, str | bytes]
files = field(default_factory=dict)
lsdtools.exports.ExportRecipe.cmake_cache#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:90.
cmake_cache: Mapping
cmake_cache = field(default_factory=dict)
lsdtools.exports.ExportRecipe.instructions#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:91.
instructions: str
instructions = ''
lsdtools.exports.ExportRecipe.required_host#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:92.
required_host: str | None
required_host = None
lsdtools.exports.ExportRecipe.required_architecture#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:93.
required_architecture: str | None
required_architecture = None
lsdtools.exports.ExportRecipe.execution_role#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:94.
execution_role: str
execution_role = 'standalone'
lsdtools.exports.ExportRecipe.network_plan_path#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:95.
network_plan_path: str | Path | None
network_plan_path = None
lsdtools.exports.ExportRecipe.network_sources_path#
Kind: attribute. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:96.
network_sources_path: str | Path | None
network_sources_path = None
lsdtools.exports.build_native#
Kind: function. Source: services/runtime_export/src/lsd_export_desktop/target.py:382.
build_native(ir: SceneIR | SimulationIR, output: Path | str, *, physics=None, compiler: Path | str | None, source_only=False, headless=False, inputs=(), extra_files=None, application=None, export_metadata=None, execution_role='standalone', network_plan=None, network_sources=None, network_simulation=None) -> dict
application: (unannotated)
compiler: Path | str | None
execution_role: (unannotated)
export_metadata: (unannotated)
extra_files: (unannotated)
headless: (unannotated)
inputs: (unannotated)
ir: SceneIR | SimulationIR
network_plan: (unannotated)
network_simulation: (unannotated)
network_sources: (unannotated)
output: Path | str
physics: (unannotated)
source_only: (unannotated)
Source docstring:
Generate and optionally compile a fresh standalone artifact; never overwrite an output.
A native build requires an explicit GCC-compatible compiler path. The direct
compiler invocation is bounded to 180 seconds; networking uses its provider's
bounded CMake builder and verified shared-library closure. Direct Windows builds
statically link the toolchain runtime. The authenticated physics DLL, when
selected, is shipped alongside the executable. Source exports include an
ordinary CMake project; they are not claims of another platform's binaries.
Implementation alias: lsd_export_desktop.target.build.
lsdtools.exports.common_fields#
Kind: function. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:163.
common_fields(*, network_roles=False)
network_roles: (unannotated)
Implementation alias: lsd_export_desktop.platforms.common_fields.
lsdtools.exports.common_recipe_values#
Kind: function. Source: services/runtime_export/src/lsd_export_desktop/platforms.py:183.
common_recipe_values(settings)
settings: (unannotated)
Implementation alias: lsd_export_desktop.platforms.common_recipe_values.
lsdtools.exports.export_project#
Kind: function. Source: sdk/src/lsdtools/exports.py:42.
export_project(platform, project, output, settings=None, *, preset=None, progress=None, network_plan=None, network_sources=None)
network_plan: (unannotated)
network_sources: (unannotated)
output: (unannotated)
platform: (unannotated)
preset: (unannotated)
progress: (unannotated)
project: (unannotated)
settings: (unannotated)
Source docstring:
Compose the shared renderer assets with a selected package's native export recipe.
lsdtools.exports.finalize_native_build#
Kind: function. Source: services/runtime_export/src/lsd_export_desktop/target.py:122.
finalize_native_build(source: Path | str, native_directory: Path | str, receipt: Path | str, output: Path | str) -> dict
native_directory: Path | str
output: Path | str
receipt: Path | str
source: Path | str
Source docstring:
Seal an externally built CMake source export and its exact native dependency closure.
Platform toolchain jobs call this data-only boundary after their native builder completes.
The receipt binds the original source manifest and target triplet; each selected native file
is independently hashed again. This proves local artifact integrity, not publisher identity.
No path mentioned in logs or commands is opened and no executable is loaded.
Implementation alias: lsd_export_desktop.target.finalize_native_build.
lsdtools.exports.open_export_window#
Kind: function. Source: views/runtime_export/src/lsd_export_view/window.py:546.
open_export_window(context, platform, *, runner=None)
context: (unannotated)
platform: (unannotated)
runner: (unannotated)
Source docstring:
Present one live export window, including from a package task worker.
Return only after its semantic controls are registered. Desktop runs package
menu callbacks on a project worker, so GTK creation is dispatched explicitly.
Implementation alias: lsd_export_view.window.open_export_window.
lsdtools.exports.runtime_assets#
Kind: function. Source: sdk/src/lsdtools/exports.py:31.
runtime_assets(bundle)
bundle: (unannotated)
lsdtools.exports.scene_assets#
Kind: function. Source: sdk/src/lsdtools/exports.py:8.
scene_assets(bundle)
bundle: (unannotated)
Source docstring:
Bake the product's shared primitive atlas and standard shader variant.
lsdtools.exports.verify_export#
Kind: function. Source: services/runtime_export/src/lsd_export_desktop/target.py:78.
verify_export(output: Path | str) -> dict
output: Path | str
Source docstring:
Verify exact files, sizes and hashes, rejecting extra files and all links.
This is integrity against the supplied manifest, not publisher authentication.
A signature authority can sign this ordinary canonical JSON document separately.
Implementation alias: lsd_export_desktop.target.verify_manifest.