Skip to content

Function: fitImage() ​

ts
function fitImage(box, natural, fit, alignX, alignY): ImageFitResult | undefined;

Experimental

Pure fit math in world px: the quad to draw and the texture sub-rect (uv 0–1, v up = image top at v=1 with flipY) to sample. Returns undefined for an empty box or zero natural size.

Parameters ​

ParameterType
box{ x0: number; x1: number; y0: number; y1: number; }
box.x0number
box.x1number
box.y0number
box.y1number
natural{ height: number; width: number; }
natural.heightnumber
natural.widthnumber
fitImageFit
alignXnumber
alignYnumber

Returns ​

ImageFitResult | undefined

Released under the MIT License.