paper()v4.0.486
Part of the @remotion/effects package.
Adds a procedural paper texture to canvas-based components such as <Video>, <HtmlInCanvas>, <CanvasImage> and <Solid>.
The effect adds paper grain, fibers, crumples, folds and speckles while preserving the source alpha mask.
Based on the open-source Paper Shaders paper texture, created by uuuulala for Paper Design.
Preview
Example
MyComp.tsximport {paper } from '@remotion/effects/paper'; import {Solid } from 'remotion'; export constMyComp :React .FC = () => { return ( <> <Solid width ={1280}height ={720}color ="#fff4d0"effects ={[paper ({roughness : 0.4,fiber : 0.3,fiberSize : 0.2,crumples : 0.3,crumpleSize : 0.35,folds : 0.65,foldCount : 5,drops : 0.2,scale : 0.6,seed : 6, }), ]} /> </> ); };
API
Pass an object with the following properties. You can also call paper() without arguments.
amount?
Strength of the paper texture from 0 to 1. Defaults to 1.
Use 0 to leave the source unchanged.
colorFront?
Light-facing paper color. Defaults to '#9fadbc'.
Alpha in the color controls how strongly this color tints the paper highlights.
colorBack?
Shadow-facing paper color. Defaults to '#ffffff'.
Alpha in the color controls how strongly this color tints the paper shadows.
contrast?
Sharpness of light and color transitions from 0 to 1. Defaults to 0.3.
Higher values make folds and crumples more pronounced.
roughness?
Fine pixel noise from 0 to 1. Defaults to 0.4.
Use 0 for a smoother texture.
fiber?
Curly fiber intensity from 0 to 1. Defaults to 0.3.
Higher values add more visible paper strands.
fiberSize?
Curly fiber scale. Defaults to 0.2. Must be greater than 0 and at most 1.
Smaller values create finer fibers.
crumples?
Cell-based crumple intensity from 0 to 1. Defaults to 0.3.
Higher values add stronger small-scale crumple marks.
crumpleSize?
Cell-based crumple scale. Defaults to 0.35. Must be greater than 0 and at most 1.
Smaller values create tighter crumple cells.
folds?
Fold lighting intensity from 0 to 1. Defaults to 0.65.
Use 0 to remove the broader fold pattern.
foldCount?
Number of generated folds from 0 to 15. Defaults to 5.
Higher values create more fold lines.
drops?
Speckle visibility from 0 to 1. Defaults to 0.2.
Use 0 to remove the speckle pattern.
fade?
Large-scale mask applied to the paper pattern from 0 to 1. Defaults to 0.
Higher values make the paper details less uniform across the frame.
seed?
Seed for the generated paper pattern from 0 to 1000. Defaults to 6.
Change it to get a different static paper pattern.
scale?
Scale of the generated paper texture. Defaults to 0.6. Must be greater than 0 and at most 4.
Smaller values create denser paper detail. Larger values make the texture broader.
disabled?
When true, the effect is skipped. Defaults to false.
Implementations
- WebGL2
- WebGPU (from v4.0.540)
See: Preferred effect backend.
Compatibility
| Browsers | Environments | |||||
|---|---|---|---|---|---|---|
Chrome | Firefox | Safari | ||||