package d2raster

Import Path
	github.com/pancsta/d2/d2renderers/d2raster (on go.dev)

Dependency Relation
	imports 29 packages, and imported by 2 packages

Involved Source Files

	    animation_value.go
	    bands.go
	    color_space.go
	    colrv1.go
	    effects.go
	    filter.go
	    geometry.go
	    gradient.go
	    image.go
	    mask_regions.go
	    pattern.go
	  d raster.go
		Package d2raster renders the supported d2scene subset with a pure-Go raster
		kernel. Unsupported scene features are rejected during preflight, before the
		final output canvas is allocated.

	    session.go
	    stroke_regions.go
	    text.go
	    vector_validation.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type FrameOptions (struct)
		FrameOptions defines the pixel mapping and hard resource ceilings for one
		render. Every limit and Scale must be positive; callers select the limits so
		production ceilings are explicit rather than hidden package defaults.

		Fields (total 22)
			Background color.Color
			MaxAnimationKeyframes int
			MaxAnimationTracks int
			MaxAssetBytes int64
			MaxAssets int
			MaxDecodedAssetBytes int64
				MaxDecodedAssetBytes bounds the cumulative resolver-declared decoded
				footprint of all retained raster assets. MaxAssetBytes separately bounds
				their encoded bytes together with retained font bytes.

			MaxDepth int
			MaxEvenOddClipWork int64
				MaxEvenOddClipWork bounds aggregate point-in-edge evaluations used by
				supersampled even-odd fills and clips.

			MaxFontFacesPerText int
				MaxFontFacesPerText bounds primary plus fallback face selection for one
				TextRun. MaxTextCoverageChecks and MaxTextShapingRuns are aggregate frame
				work ceilings. Zero selects bounded defaults.

			MaxHeight int
			MaxImportDepth int
				MaxImportDepth bounds active vector-asset nesting. Retained vector roots
				and visible vector Image instances start at depth one; raster images do
				not consume this budget.

			MaxNodes int
				Stored vector definitions are charged once by structural graph
				validation. Every rendered vector Image then charges its instantiated
				subtree again. Animation limits follow the same retained-plus-instantiated
				policy and are charged before per-node animation bookkeeping is allocated.
				Retained MaxDepth validation includes the unavoidable host Image at depth
				one, so an intrinsically unplaceable definition is rejected even if unused.
				MaxNodes also bounds aggregate filter entries and synthesized color-glyph
				layers as separate structural dimensions, preventing arbitrarily long
				identity-filter chains or color-font layer lists.

			MaxOffscreenBytes int64
				MaxOffscreenBytes bounds the peak live pixel backing storage used by
				retained pattern tiles, temporary RGBA effect/filter layers, Alpha blur
				and effect masks, and retained scanline-rasterizer scratch. It excludes
				decoded assets (bounded separately), the final frame canvas, and returned
				image.

			MaxPathCommands int
			MaxPixels int64
			MaxScanlineWork int64
				MaxScanlineWork bounds aggregate operation units used by non-zero fills,
				strokes, streamed paint coverage, and clips. Zero selects a bounded default;
				negative values are invalid.

			MaxTextCoverageChecks int64
			MaxTextRunesPerRun int
				MaxTextRunesPerRun bounds one non-interruptible segmentation/shaping
				call. Zero selects the default; negative values are invalid.
				Aggregate shaped glyphs remain bounded by MaxPathCommands.

			MaxTextShapingRuns int
			MaxWidth int
			Scale float64
			Time time.Duration
		As Inputs Of (at least 5)
			func Render(ctx context.Context, document *d2scene.Document, options FrameOptions) (*image.NRGBA, error)
			func RenderBands(ctx context.Context, document *d2scene.Document, options FrameOptions, bandHeight int, consume func(*image.NRGBA) error) error
			func (*RenderSession).Render(ctx context.Context, document *d2scene.Document, options FrameOptions) (*image.NRGBA, error)
			func (*RenderSession).RenderBands(ctx context.Context, document *d2scene.Document, options FrameOptions, bandHeight int, consume func(*image.NRGBA) error) error
			func (*RenderWorkspace).Render(ctx context.Context, session *RenderSession, document *d2scene.Document, options FrameOptions, consume func(*image.NRGBA) error) error

	 type RenderSession (struct)
		RenderSession reuses immutable parsed fonts and decoded raster pixels
		across renders. Scene validation and every per-document resource limit are
		still applied independently on every Render call. Callers may replace an
		asset value, but must not mutate an existing Data backing allocation, as
		required by d2scene.Asset.

		Methods (total 3)
			(*RenderSession) Render(ctx context.Context, document *d2scene.Document, options FrameOptions) (*image.NRGBA, error)
				Render preflights and renders one frame while reusing this session's bounded
				parsed-font and decoded-raster cache.

			(*RenderSession) RenderBands(ctx context.Context, document *d2scene.Document, options FrameOptions, bandHeight int, consume func(*image.NRGBA) error) error
				RenderBands reuses the session's bounded font and raster-asset cache while
				rendering consecutive borrowed bands. Its contract is otherwise RenderBands'.

			(*RenderSession) Stats() RenderSessionStats
				Stats returns a race-free snapshot of cache counters and current retained
				charged storage.

		As Outputs Of (at least one exported)
			func NewRenderSession(options RenderSessionOptions) (*RenderSession, error)
		As Inputs Of (at least one exported)
			func (*RenderWorkspace).Render(ctx context.Context, session *RenderSession, document *d2scene.Document, options FrameOptions, consume func(*image.NRGBA) error) error

	 type RenderSessionOptions (struct)
		RenderSessionOptions bounds reusable parsed and decoded asset state. Every
		field must be positive. MaxCacheEntries independently caps asset entries and
		immutable-source key memos, so a session may retain up to twice that many
		entries. MaxCacheBytes jointly bounds both groups. Entries charge source and
		MIME bytes for fonts, validated decoded footprint and MIME bytes for raster
		images, or the encoded source length for key memos, plus
		cacheEntryOverheadBytes each.

		Fields (total 3)
			MaxCacheBytes int64
			MaxCacheEntries int
			MaxConcurrentLoads int
		As Inputs Of (at least one exported)
			func NewRenderSession(options RenderSessionOptions) (*RenderSession, error)

	 type RenderSessionStats (struct)
		RenderSessionStats is an atomic snapshot of cache activity. Hits, Misses,
		and Waits describe parsed-font and decoded-raster lookups. MemoHits,
		MemoMisses, and MemoWaits describe content-key lookups; Hashes counts full
		source scans. SkippedOversize and MemoSkipped count successful results that
		could not be retained under MaxCacheBytes.

		Fields (total 17)
			ActiveLoads int
			Bytes int64
			Entries int
			Evictions uint64
			Hashes uint64
			Hits uint64
			MemoBytes int64
			MemoEntries int
			MemoEvictions uint64
			MemoHits uint64
			MemoMisses uint64
			MemoSkipped uint64
			MemoWaits uint64
			Misses uint64
			RetainedBytes int64
			SkippedOversize uint64
			Waits uint64
		As Outputs Of (at least one exported)
			func (*RenderSession).Stats() RenderSessionStats

	 type RenderWorkspace (struct)
		RenderWorkspace retains at most one final-frame backing store and one
		exact-plan scanline rasterizer for a sequence of renders. Before each call it
		drops rasterizer capacity that exceeds the new MaxOffscreenBytes limit. Its
		zero value is ready for use. Render serializes concurrent calls, while the
		separate RenderSession remains safe to share with other workspaces.
		Canvas capacity can retain the largest frame reached by a call, including a
		call canceled after painting begins, for the workspace's lifetime. Reset
		releases all retained storage when an operation ends. A RenderWorkspace must
		not be copied after first use.
		
		The frame passed to consume is borrowed and is valid only until consume
		returns; callers that retain frames must continue to use RenderSession.Render,
		which returns independently owned pixels. Every call still performs complete
		preflight and applies all limits from its FrameOptions.

		Methods (total 2)
			(*RenderWorkspace) Render(ctx context.Context, session *RenderSession, document *d2scene.Document, options FrameOptions, consume func(*image.NRGBA) error) error
				Render paints one frame into reusable workspace storage and calls consume
				before that storage can be reused. The workspace remains exclusively held
				while consume runs, so consume must not re-enter the same RenderWorkspace.

			(*RenderWorkspace) Reset()
				Reset releases all final-frame and scanline storage retained by w. It waits
				for an active Render and is safe to call on a nil workspace.



Package-Level Functions (total 4)

	 func EncodePNG(ctx context.Context, img image.Image) ([]byte, error)
		EncodePNG deterministically encodes img as PNG.

	 func NewRenderSession(options RenderSessionOptions) (*RenderSession, error)
		NewRenderSession creates a bounded, concurrent-safe render session.

	 func Render(ctx context.Context, document *d2scene.Document, options FrameOptions) (*image.NRGBA, error)
		Render preflights document and returns a newly allocated NRGBA frame. The
		viewbox is mapped to LogicalWidth x LogicalHeight and then multiplied by
		FrameOptions.Scale.

	 func RenderBands(ctx context.Context, document *d2scene.Document, options FrameOptions, bandHeight int, consume func(*image.NRGBA) error) error
		RenderBands renders a frame from top to bottom using a reusable canvas of at
		most bandHeight rows. Each NRGBA band has absolute frame coordinates, full
		frame width, and consecutive rows. Its pixels are borrowed only until consume
		returns; a consumer that retains a band must copy it.
		
		Geometry and assets are prepared once. All resource limits, including the
		aggregate scanline and even-odd work of every band and filter overlap, are
		checked before the first callback. MaxPixels still bounds total output pixels;
		only the band canvas, rather than the full frame, must fit platform storage.
		MaxOffscreenBytes separately bounds retained pattern tiles and rendering
		scratch. The final band may have fewer rows. On any error, consume receives no
		further bands. A callback must not modify document or its assets.

The pages are generated with Golds v0.8.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.