Public API reference
The current preview.3 JavaDoc includes the fluent API, creative controls, parameter units, defaults, limits and lifecycle contracts. Matching sources and JavaDoc JARs accompany ke.ric:renderer-api:2.3.0-preview.3 for IDE hover help. Use the ShutterBug Renderer 1.1.0 platform JAR with its embedded native library; an older provider cannot gain new runtime controls from this dependency.
Start with Renderer, SnapshotBuilder, StreamBuilder and RenderedFrame. RenderRecipe / RenderLayer compose selected output. RenderEnvironment, RenderAppearance and RenderLighting control rendering independently. RendererSession / RendererClient retain advanced capture, scenes, assets and submission.
The complete public type inventory below links the same generated reference included with this documentation build. Historical SDK releases and their existing versioned JavaDoc URLs remain unchanged.
- AssetHandle
- AssetPack
- Attachment
- CaptureProvenance
- CaptureRequest
- CapturedEntity
- ChunkSectionState
- CompositionLease
- EntitySelector
- FrameProgress
- FrameProgress.Stage
- LayerColor
- LayerColor.Mode
- LightDirection
- LightSpace
- LightingCapabilities
- MapDither
- MapFrame
- MapOutputOptions
- MapSink
- MinecraftMapConverter
- Occlusion
- PngConverter
- PointLight
- RenderAppearance
- RenderEnvironment
- RenderFailureCode
- RenderJob
- RenderLayer
- RenderLighting
- RenderPassResult
- RenderProgress
- RenderProgress.Phase
- RenderRecipe
- RenderResult
- RenderSettings
- RenderSettings.Profile
- RenderStatus
- RenderStream
- RenderStream.Status
- RenderTask
- RenderTimings
- RenderedFrame
- RenderedMap
- Renderer
- RendererCapabilities
- RendererClient
- RendererException
- RendererException.Detail
- RendererService
- RendererSession
- ResolvedLabel
- ResolvedMaterial
- ResolvedMaterial.AlphaMode
- ResolvedMesh
- ResolvedRenderTarget
- ResolvedTexture
- ResolvedTransform
- ResolvedTriangle
- ResolvedTriangle.Face
- Scene
- SceneBuilder
- SceneCamera
- SceneContent
- SceneEntity
- SceneEntity.Builder
- SceneOperation
- SceneReusePolicy
- SceneSelection
- SceneSelection.EntityMode
- SceneStructure
- SceneTransform
- SnapshotBuilder
- SpotLight
- StreamBuilder
- VirtualLight
- VisibilityStatistics
- VisibleEntity
- Weather