### Install Rendley SDK Source: https://docs.rendleysdk.com/quick-start/installation Installs the Rendley SDK package using npm. This is the first step to integrate Rendley into your project. ```bash npm install @rendley/sdk ``` -------------------------------- ### Pixi.StartupSystem API Source: https://docs.rendleysdk.com/api-reference/classes/TextStyle Documentation for the StartupSystem class in the Pixi namespace. Handles initialization tasks. ```APIDOC Pixi.StartupSystem: // Manages the startup sequence and initialization of various systems. // Methods for registering startup tasks and executing them. ``` -------------------------------- ### Rendley Video Editor UI CDN Setup Source: https://docs.rendleysdk.com/video-editor-ui/installation This snippet demonstrates how to embed the Rendley Video Editor UI using a CDN. It includes importing custom elements and configuring the editor with license and API keys. Ensure you replace placeholder values with your actual credentials. ```html ``` -------------------------------- ### Pixi Preparation and Rendering Pipeline Classes Source: https://docs.rendleysdk.com/api-reference/types/HighlightTextStyle API documentation for Pixi's preparation and rendering pipeline management. This includes Prepare, Program, ProjectionSystem, Quad, QuadUv, Rectangle, Renderer, and RenderTexture for controlling the rendering process and managing render targets. ```APIDOC Prepare: Description: Manages the preparation of assets for rendering. Program: Description: Represents a shader program. ProjectionSystem: Description: Manages projection matrices. Quad: Description: Represents a quad. QuadUv: Description: Represents a quad with UV coordinates. Rectangle: Description: Represents a rectangle with x, y, width, and height properties. Properties: x: number y: number width: number height: number Renderer: Description: The main rendering context for Pixi. RenderTexture: Description: A texture that can be rendered to. ``` -------------------------------- ### Pixi Interfaces and Options Source: https://docs.rendleysdk.com/api-reference/interfaces/LibrarySetupData This section documents various interfaces and options within the Pixi namespace of the Rendley SDK. These cover aspects like text styling, resource loading, rendering, and more. ```APIDOC IHTMLTextFontOptions: Defines font options for HTML text. IHTMLTextStyle: Specifies the style properties for HTML text. IImageBitmapResourceOptions: Options for loading image bitmap resources. IImageResourceOptions: Options for loading general image resources. ILineStyleOptions: Options for defining line styles. IMaskTarget: Represents a target for masking operations. IMeshMaterialOptions: Options for mesh materials. IParticleProperties: Properties for particles in particle systems. IParticleRendererProperty: Properties related to particle rendering. IPoint: Represents a point in 2D space. IPointData: Data structure for point information. IProgramExtraData: Additional data for shader programs. IRenderableContainer: An interface for containers that can be rendered. IRenderableObject: An interface for objects that can be rendered. IRenderer: The main renderer interface. IRendererConstructor: Constructor for the Renderer. IRendererOptions: General options for the renderer. IRendererOptionsAuto: Automatic options for the renderer. IRendererPlugins: Defines the plugins available for the renderer. IRendererRenderOptions: Options for the render method. IRenderingContext: The rendering context. IResourcePlugin: Interface for resource loading plugins. ISize: Represents a size (width and height). ISpriteMaskFilter: Filter for sprite masking. ISpriteMaskTarget: Target for sprite masking. ISpritesheetData: Data structure for spritesheet information. ISpritesheetFrameData: Data for individual frames in a spritesheet. ISupportDict: Dictionary for supported features. ISVGResourceOptions: Options for loading SVG resources. ISystem: Represents a system component. ITextStyle: Defines text style properties. ITextureBorders: Defines texture border properties. ITypedArray: Represents a typed array. IUniformData: Data for shader uniforms. IUniformParser: Interface for parsing shader uniforms. IUnloadableTexture: Interface for textures that can be unloaded. IVideoResourceOptions: Options for loading video resources. IVideoResourceOptionsElement: Options for loading video resources from an element. LoaderParser: Interface for loader parsers. LoadTextureConfig: Configuration for loading textures. LoadVideoConfig: Configuration for loading videos. PixiTouch: Represents touch input handling in Pixi. PreferOrder: Defines preference order for something. ResizePluginOptions: Options for the resize plugin. ResolvedAsset: Represents a resolved asset. ResolveURLParser: Interface for parsing URLs. SpriteSheetJson: Represents spritesheet data in JSON format. ``` -------------------------------- ### Video Editor UI Pro Installation and Integration Source: https://docs.rendleysdk.com/video-editor-ui/pro Guides users through the installation, configuration, and integration process for the Rendley Video Editor UI Pro version, including obtaining necessary API keys and setting up a development environment. ```APIDOC Video Editor UI Pro: Installation: - Install Dependencies: Steps to install required software and libraries. - Edit the Configuration: Instructions for modifying configuration files. - Get a Free License: Process for acquiring a license key. - Get a Pexels API Key: Steps to obtain an API key from Pexels. - Get a Giphy API Key: Steps to obtain an API key from Giphy. - Start the Development Server: Commands to launch the local development server. Build: - Instructions for building the project for deployment. Integration: - Publish as a Private NPM Package: Steps to package and publish the UI as an NPM package. - Upload to CDN: Guidance on deploying the UI to a Content Delivery Network. Framework Integration: - Information on integrating the Video Editor UI with various frontend frameworks. ``` -------------------------------- ### Pixi Rendering Systems API Source: https://docs.rendleysdk.com/api-reference/hierarchy Documentation for various rendering systems within the Pixi namespace, including ObjectRendererSystem, PluginSystem, Prepare, ProjectionSystem, RenderTextureSystem, ShaderSystem, StartupSystem, StateSystem, TextureGCSystem, TextureSystem, TransformFeedbackSystem, and ViewSystem. ```APIDOC Pixi.ObjectRendererSystem: Description: Manages object rendering within the Pixi engine. Pixi.PluginSystem: Description: Handles the system for plugins in Pixi. Pixi.Prepare: Description: Manages the preparation of assets for rendering. Pixi.ProjectionSystem: Description: Controls the projection transformations for rendering. Pixi.RenderTextureSystem: Description: Manages rendering to textures. Pixi.ShaderSystem: Description: Handles shader management and application. Pixi.StartupSystem: Description: Manages the startup sequence of systems. Options Interface: Pixi.StartupSystemOptions Pixi.StateSystem: Description: Manages the rendering state. Pixi.TextureGCSystem: Description: Handles garbage collection for textures. Pixi.TextureSystem: Description: Manages texture loading and caching. Pixi.TransformFeedbackSystem: Description: Manages transform feedback operations. Pixi.ViewSystem: Description: Controls the view and viewport settings. Options Interface: Pixi.ViewSystemOptions ``` -------------------------------- ### Initialize Rendley Engine Source: https://docs.rendleysdk.com/quick-start/installation Initializes the Rendley Engine with license details and display configurations. Ensure 'YOUR_LICENSE_NAME' and 'YOUR_LICENSE_KEY' are replaced with valid credentials and the correct canvas element is provided. ```typescript import { Engine } from "@rendley/sdk"; const engine = Engine.getInstance().init({ license: { licenseName: "YOUR_LICENSE_NAME", licenseKey: "YOUR_LICENSE_KEY", }, display: { width: 1080, height: 1920, backgroundColor: "#000000", view: document.getElementById("myCanvas"), }, }); ``` -------------------------------- ### Interact with Rendley SDK Engine Source: https://docs.rendleysdk.com/video-editor-ui/installation Demonstrates how to access the Rendley SDK's Engine class after the video editor is ready and how to listen for various events like render success, render error, and library additions. It emphasizes waiting for the 'onReady' event before accessing the Engine. ```javascript let rendleyTemplateElement = document.getElementById("rendley"); rendleyTemplateElement.addEventListener("onRenderSuccess", (blobUrl) => { // Handle render success }); rendleyTemplateElement.addEventListener("onRenderError", (message) => { // Handle render error }); rendleyTemplateElement.addEventListener("onReady", async () => { const Engine = await rendleyTemplateElement.getEngine(); Engine.getInstance().events.on("library:added", (mediaDataId) => { // Handle library added event }); }); ``` -------------------------------- ### Pixi BasePrepare Class Source: https://docs.rendleysdk.com/api-reference/variables/PropertyAnimationSchema Documentation for the Pixi BasePrepare class. Handles the preparation of resources for rendering. ```APIDOC BasePrepare: Handles resource preparation for rendering. ``` -------------------------------- ### Install @rendley/sdk using npm Source: https://docs.rendleysdk.com/api-reference/index Installs the Rendley SDK package using npm. This command fetches and installs the latest version of the SDK, including type definitions for TypeScript integration. ```bash npm install @rendley/sdk ``` -------------------------------- ### Pixi Functions Source: https://docs.rendleysdk.com/api-reference/interfaces/LibrarySetupData Documentation for various functions within the Pixi namespace, including asset detection, resource detection, shader utilities, and asset loading. ```APIDOC autoDetectRenderer(): Renderer Automatically detects and returns a suitable renderer. autoDetectResource(url: string, options?: any): Resource Automatically detects and creates a resource from a URL. checkDataUrl(dataUrl: string): boolean Checks if a string is a valid data URL. checkExtension(url: string, ext: string): boolean Checks if a URL has a specific extension. checkMaxIfStatementsInShader(shader: string): boolean Checks if a shader exceeds the maximum number of if statements. convertToList(value: any): any[] Converts a value to a list. copySearchParams(source: URL, destination: URL): void Copies search parameters from one URL to another. createStringVariations(value: string): string[] Creates variations of a string. createTexture(source: TextureSource, options?: any): Texture Creates a texture from a TextureSource. generateProgram(vertexSrc: string, fragmentSrc: string): Program Generates a shader program from vertex and fragment shader sources. ``` -------------------------------- ### Install @rendley/sdk using yarn Source: https://docs.rendleysdk.com/api-reference/index Installs the Rendley SDK package using yarn. This command fetches and installs the latest version of the SDK, including type definitions for TypeScript integration. ```bash yarn add @rendley/sdk ``` -------------------------------- ### RendleySDK Pixi Classes Source: https://docs.rendleysdk.com/api-reference/interfaces/TransitionOptions Documentation for various classes within the RendleySDK's Pixi namespace, covering rendering primitives, systems, and utilities. ```APIDOC QuadUv: Description: Represents a quad with UV coordinates. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.QuadUv.html Rectangle: Description: Represents a rectangular area. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.Rectangle.html Renderer: Description: Handles the rendering process. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.Renderer.html RenderTexture: Description: Represents a texture that can be rendered to. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.RenderTexture.html RenderTexturePool: Description: Manages a pool of render textures. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.RenderTexturePool.html RenderTextureSystem: Description: System for managing render textures. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.RenderTextureSystem.html Resolver: Description: Handles resource resolution. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.Resolver.html Resource: Description: Base class for resources. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.Resource.html RopeGeometry: Description: Geometry for rope-like structures. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.RopeGeometry.html RoundedRectangle: Description: Represents a rectangle with rounded corners. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.RoundedRectangle.html Runner: Description: Manages a list of tasks or callbacks. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.Runner.html ScissorSystem: Description: System for scissor clipping. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.ScissorSystem.html Shader: Description: Represents a shader program. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.Shader.html ShaderSystem: Description: System for managing shaders. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.ShaderSystem.html SimpleMesh: Description: A simple mesh object. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.SimpleMesh.html SimplePlane: Description: A simple plane object. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.SimplePlane.html SimpleRope: Description: A simple rope object. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.SimpleRope.html Sprite: Description: Represents a sprite object. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.Sprite.html SpriteMaskFilter: Description: A filter for sprite masking. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.SpriteMaskFilter.html Spritesheet: Description: Represents a spritesheet. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.Spritesheet.html StartupSystem: Description: System for handling startup processes. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.StartupSystem.html State: Description: Represents a state. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.State.html StateSystem: Description: System for managing states. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.StateSystem.html StencilSystem: Description: System for stencil buffer operations. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.StencilSystem.html SVGResource: Description: Resource for SVG data. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.SVGResource.html SystemManager: Description: Manages various systems. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.SystemManager.html Text: Description: Represents text objects. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.Text.html TextMetrics: Description: Metrics for text rendering. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.TextMetrics.html TextStyle: Description: Defines the style for text. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.TextStyle.html Texture: Description: Represents a texture. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.Texture.html TextureGCSystem: Description: System for texture garbage collection. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.TextureGCSystem.html TextureMatrix: Description: Matrix for texture transformations. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.TextureMatrix.html TextureSystem: Description: System for texture management. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.TextureSystem.html Ticker: Description: Manages the update loop. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.Ticker.html TickerPlugin: Description: Plugin for the Ticker. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.TickerPlugin.html TilingSprite: Description: A sprite that tiles. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.TilingSprite.html TilingSpriteRenderer: Description: Renderer for tiling sprites. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.TilingSpriteRenderer.html TimeLimiter: Description: Limits operations by time. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.TimeLimiter.html Transform: Description: Represents a transformation matrix. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.Transform.html TransformFeedback: Description: Represents transform feedback. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.TransformFeedback.html TransformFeedbackSystem: Description: System for transform feedback. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.TransformFeedbackSystem.html UniformGroup: Description: Group for uniform variables. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.UniformGroup.html VideoResource: Description: Resource for video data. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.VideoResource.html ViewableBuffer: Description: A buffer that can be viewed. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.ViewableBuffer.html ViewSystem: Description: System for managing views. URL: https://docs.rendleysdk.com/api-reference/classes/Pixi.ViewSystem.html ``` -------------------------------- ### Rendley SDK Classes Source: https://docs.rendleysdk.com/api-reference/interfaces/LibrarySetupData Documentation for core classes in the Rendley SDK, including controllers, media, and effects. ```APIDOC AnimationController: Manages animation playback and control. AudioClip: Represents an audio clip. BuiltInBlurEffect: Represents a built-in blur effect. ``` -------------------------------- ### Zod Object Schema Example Source: https://docs.rendleysdk.com/api-reference/variables/TextStyleSchema Example of defining and validating a Zod object schema. ```TypeScript import { z } from 'zod'; const userSchema = z.object({ name: z.string().min(1), email: z.string().email(), age: z.number().positive().optional() }); const validUser = { name: 'John Doe', email: 'john.doe@example.com' }; const invalidUser = { name: '', email: 'invalid-email' }; console.log(userSchema.safeParse(validUser)); // { success: true, data: { name: 'John Doe', email: 'john.doe@example.com' } } console.log(userSchema.safeParse(invalidUser)); // { success: false, error: [ZodError] } ``` -------------------------------- ### Transition Class API Documentation Source: https://docs.rendleysdk.com/api-reference/classes/Transition Provides comprehensive API documentation for the Transition class, including its constructor and all public methods. This documentation covers method signatures, parameters, return types, and usage. ```APIDOC Class Transition: constructor(options: TransitionOptions): Transition Parameters: options: TransitionOptions - Configuration options for the transition. Returns: Transition - An instance of the Transition class. destroy(): void Description: Cleans up resources used by the transition. Returns: void getEndClip(): Clip> Description: Retrieves the end clip associated with the transition. Returns: Clip> - The end clip object. getEndClipId(): string Description: Retrieves the ID of the end clip. Returns: string - The ID of the end clip. getStartClip(): Clip> Description: Retrieves the start clip associated with the transition. Returns: Clip> - The start clip object. getStartClipId(): string Description: Retrieves the ID of the start clip. Returns: string - The ID of the start clip. getTransitionProgress(): number Description: Gets the current progress of the transition. Returns: number - The transition progress, typically between 0 and 1. init(): void Description: Initializes the transition. Returns: void onPause(): void Description: Callback function executed when the transition is paused. Returns: void onPlay(): void Description: Callback function executed when the transition starts playing. Returns: void onResize(): void Description: Callback function executed when the transition is resized. Returns: void render(): void Description: Renders the current state of the transition. Returns: void serialize(): object Description: Serializes the transition's state into an object. Returns: object - A serializable representation of the transition. deserialize(data: object): void Description: Deserializes the transition's state from an object. Parameters: data: object - The data to deserialize. Returns: void setEndClipId(clipId: string): void Description: Sets the ID for the end clip. Parameters: clipId: string - The ID of the end clip. Returns: void setInDuration(duration: number): void Description: Sets the duration for the 'in' effect of the transition. Parameters: duration: number - The duration in milliseconds. Returns: void setName(name: string): void Description: Sets the name of the transition. Parameters: name: string - The name for the transition. Returns: void setOutDuration(duration: number): void Description: Sets the duration for the 'out' effect of the transition. Parameters: duration: number - The duration in milliseconds. Returns: void setProperty(key: string, value: any): void Description: Sets a custom property on the transition. Parameters: key: string - The name of the property. value: any - The value of the property. Returns: void setStartClipId(clipId: string): void Description: Sets the ID for the start clip. Parameters: clipId: string - The ID of the start clip. Returns: void update(deltaTime: number): void Description: Updates the transition's state based on the time elapsed. Parameters: deltaTime: number - The time elapsed since the last update in milliseconds. Returns: void getInDuration(): number Description: Retrieves the duration of the 'in' effect. Returns: number - The 'in' duration in milliseconds. getOutDuration(): number Description: Retrieves the duration of the 'out' effect. Returns: number - The 'out' duration in milliseconds. getId(): string Description: Retrieves the unique identifier of the transition. Returns: string - The transition ID. getName(): string Description: Retrieves the name of the transition. Returns: string - The transition name. getProperty(key: string): any Description: Retrieves the value of a custom property. Parameters: key: string - The name of the property to retrieve. Returns: any - The value of the property, or undefined if not found. getProvider(): string Description: Retrieves the provider of the transition. Returns: string - The provider name. getSprite(): Sprite Description: Retrieves the sprite associated with the transition. Returns: Sprite - The sprite object. getTransitionId(): string Description: Retrieves the unique identifier for the transition. Returns: string - The transition identifier. ``` -------------------------------- ### Zod Date Schema Example Source: https://docs.rendleysdk.com/api-reference/variables/TextStyleSchema Example of creating and validating a Zod date schema. ```TypeScript import { z } from 'zod'; const dateSchema = z.date(); const today = new Date(); console.log(dateSchema.parse(today)); // Returns the Date object // console.log(dateSchema.parse('2023-10-27')); // Throws ZodError ``` -------------------------------- ### Pixi Interfaces Source: https://docs.rendleysdk.com/api-reference/interfaces/LibrarySetupData Documentation for various interfaces within the Pixi namespace, defining contracts for asset handling and system configurations. ```APIDOC Pixi.AssetExtension: Defines the structure for an asset extension. Pixi.AssetInitOptions: Options for initializing assets. Pixi.AssetsBundle: Represents a bundle of assets. Pixi.AssetsManifest: Defines the structure for an assets manifest. Pixi.AssetsPreferences: Preferences for asset loading. Pixi.BackgroundSystemOptions: Options for the Background System. Pixi.CacheParser: Interface for parsing cached data. Pixi.ContextSystemOptions: Options for the Context System. ``` -------------------------------- ### Zod Array Schema Example Source: https://docs.rendleysdk.com/api-reference/variables/TextStyleSchema Example of defining and validating a Zod array schema. ```TypeScript import { z } from 'zod'; const numberArraySchema = z.array(z.number()); console.log(numberArraySchema.parse([1, 2, 3])); // [ 1, 2, 3 ] // console.log(numberArraySchema.parse([1, 'a', 3])); // Throws ZodError ``` -------------------------------- ### Zod Refinement Example Source: https://docs.rendleysdk.com/api-reference/variables/SubtitlesSchema Example of adding custom validation logic using refinement. ```TypeScript import { z } from "zod"; const ageSchema = z.number().refine((age) => age >= 18, { message: "Must be 18 or older", }); const result = ageSchema.safeParse(25); console.log(result); const invalidResult = ageSchema.safeParse(17); console.log(invalidResult); ``` -------------------------------- ### Pixi Classes and Systems Source: https://docs.rendleysdk.com/api-reference/interfaces/GifClipOptions This section lists various classes and systems available within the Pixi namespace of the Rendley SDK. Each entry links to detailed API documentation for that specific component, covering its methods, properties, and usage. ```APIDOC ParticleContainer: Description: Manages a batch of particles for efficient rendering. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.ParticleContainer.html ParticleRenderer: Description: Renders particle systems. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.ParticleRenderer.html PlaneGeometry: Description: Represents a simple plane geometry. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.PlaneGeometry.html PluginSystem: Description: Manages and applies plugins to the rendering pipeline. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.PluginSystem.html Point: Description: Represents a 2D point with x and y coordinates. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Point.html Polygon: Description: Represents a polygon defined by a series of points. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Polygon.html Prepare: Description: Handles the preparation of assets for rendering. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Prepare.html Program: Description: Represents a shader program. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Program.html ProjectionSystem: Description: Manages the projection matrix for rendering. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.ProjectionSystem.html Quad: Description: Represents a quadrilateral. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Quad.html QuadUv: Description: Represents a quadrilateral with UV coordinates. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.QuadUv.html Rectangle: Description: Represents a rectangle with x, y, width, and height. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Rectangle.html Renderer: Description: The main rendering engine. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Renderer.html RenderTexture: Description: Represents a texture that can be rendered to. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.RenderTexture.html RenderTexturePool: Description: Manages a pool of render textures for efficiency. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.RenderTexturePool.html RenderTextureSystem: Description: System for managing render textures. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.RenderTextureSystem.html Resolver: Description: Resolves resources and dependencies. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Resolver.html Resource: Description: Base class for all resources. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Resource.html RopeGeometry: Description: Represents geometry for a rope. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.RopeGeometry.html RoundedRectangle: Description: Represents a rectangle with rounded corners. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.RoundedRectangle.html Runner: Description: Manages a list of functions to be called. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Runner.html ScissorSystem: Description: Manages the scissor rectangle for clipping. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.ScissorSystem.html Shader: Description: Represents a shader. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Shader.html ShaderSystem: Description: Manages shader programs and uniforms. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.ShaderSystem.html SimpleMesh: Description: Represents a simple mesh. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.SimpleMesh.html SimplePlane: Description: Represents a simple plane. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.SimplePlane.html SimpleRope: Description: Represents a simple rope. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.SimpleRope.html Sprite: Description: Represents a sprite for displaying images. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Sprite.html SpriteMaskFilter: Description: A filter for masking sprites. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.SpriteMaskFilter.html Spritesheet: Description: Represents a spritesheet for managing texture atlases. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Spritesheet.html StartupSystem: Description: Manages the startup sequence of systems. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.StartupSystem.html State: Description: Represents a state in the application. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.State.html StateSystem: Description: Manages the application's state. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.StateSystem.html StencilSystem: Description: Manages the stencil buffer for rendering. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.StencilSystem.html SVGResource: Description: Resource for loading and handling SVG files. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.SVGResource.html SystemManager: Description: Manages all systems within the renderer. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.SystemManager.html Text: Description: Represents text for display. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Text.html TextMetrics: Description: Provides metrics for text rendering. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.TextMetrics.html TextStyle: Description: Defines the style properties for text. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.TextStyle.html Texture: Description: Represents a texture for rendering. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Texture.html TextureGCSystem: Description: Manages garbage collection for textures. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.TextureGCSystem.html TextureMatrix: Description: Manages texture transformations. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.TextureMatrix.html TextureSystem: Description: Manages texture loading and binding. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.TextureSystem.html Ticker: Description: Manages the game loop and updates. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Ticker.html TickerPlugin: Description: A plugin for the Ticker. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.TickerPlugin.html TilingSprite: Description: A sprite that can be tiled. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.TilingSprite.html TilingSpriteRenderer: Description: Renders tiling sprites. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.TilingSpriteRenderer.html TimeLimiter: Description: Limits the execution time of operations. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.TimeLimiter.html Transform: Description: Represents a 2D transformation matrix. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Transform.html TransformFeedback: Description: Manages transform feedback operations. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.TransformFeedback.html TransformFeedbackSystem: Description: System for managing transform feedback. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.TransformFeedbackSystem.html UniformGroup: Description: Manages a group of uniforms for shaders. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.UniformGroup.html VideoResource: Description: Resource for loading and handling video files. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.VideoResource.html ``` -------------------------------- ### Pixi Classes and Systems Documentation Source: https://docs.rendleysdk.com/api-reference/interfaces/TransitionDataOptions This section lists and describes various classes and systems available within the Pixi namespace of the RendleySDK. Each entry links to detailed API documentation for specific components. ```APIDOC DisplacementFilter: Description: Represents a displacement filter. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.DisplacementFilter.html DisplayObject: Description: Base class for all display objects. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.DisplayObject.html Ellipse: Description: Represents an ellipse. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Ellipse.html EventBoundary: Description: Handles event boundaries. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.EventBoundary.html EventSystem: Description: Manages the event system. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.EventSystem.html Extract: Description: Utility for extracting data from the canvas. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Extract.html FederatedEvent: Description: Base class for federated events. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.FederatedEvent.html FederatedMouseEvent: Description: Represents a federated mouse event. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.FederatedMouseEvent.html FederatedPointerEvent: Description: Represents a federated pointer event. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.FederatedPointerEvent.html FederatedWheelEvent: Description: Represents a federated wheel event. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.FederatedWheelEvent.html FillStyle: Description: Defines a fill style. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.FillStyle.html Filter: Description: Base class for filters. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Filter.html FilterSystem: Description: Manages the filter system. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.FilterSystem.html Framebuffer: Description: Represents a framebuffer. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Framebuffer.html FramebufferSystem: Description: Manages the framebuffer system. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.FramebufferSystem.html FXAAFilter: Description: Fast Approximate Anti-aliasing filter. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.FXAAFilter.html GenerateTextureSystem: Description: Manages texture generation. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.GenerateTextureSystem.html Geometry: Description: Represents geometric data. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Geometry.html GeometrySystem: Description: Manages the geometry system. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.GeometrySystem.html GLFramebuffer: Description: Represents a WebGL framebuffer. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.GLFramebuffer.html GLProgram: Description: Represents a WebGL program. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.GLProgram.html GLTexture: Description: Represents a WebGL texture. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.GLTexture.html Graphics: Description: Renders vector graphics. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Graphics.html GraphicsData: Description: Data structure for graphics. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.GraphicsData.html GraphicsGeometry: Description: Geometry for graphics. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.GraphicsGeometry.html HTMLText: Description: Renders text using HTML. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.HTMLText.html HTMLTextStyle: Description: Style for HTML text. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.HTMLTextStyle.html ImageBitmapResource: Description: Resource for ImageBitmap. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.ImageBitmapResource.html ImageResource: Description: Resource for images. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.ImageResource.html LineStyle: Description: Defines a line style. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.LineStyle.html Loader: Description: Handles asset loading. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Loader.html MaskData: Description: Data for masking. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.MaskData.html MaskSystem: Description: Manages the mask system. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.MaskSystem.html Matrix: Description: Represents a 2D transformation matrix. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Matrix.html Mesh: Description: Represents a mesh. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Mesh.html MeshBatchUvs: Description: UV batching for meshes. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.MeshBatchUvs.html MeshGeometry: Description: Geometry for meshes. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.MeshGeometry.html MeshMaterial: Description: Material for meshes. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.MeshMaterial.html MultisampleSystem: Description: Manages multisample anti-aliasing. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.MultisampleSystem.html NineSlicePlane: Description: A plane that can be sliced into nine parts. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.NineSlicePlane.html NoiseFilter: Description: A filter that applies noise. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.NoiseFilter.html ObjectRenderer: Description: Base class for object renderers. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.ObjectRenderer.html ObjectRendererSystem: Description: Manages object renderers. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.ObjectRendererSystem.html ObservablePoint: Description: A point that can be observed for changes. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.ObservablePoint.html ParticleContainer: Description: A container optimized for particles. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.ParticleContainer.html ParticleRenderer: Description: Renders particles. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.ParticleRenderer.html PlaneGeometry: Description: Geometry for a plane. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.PlaneGeometry.html PluginSystem: Description: Manages plugins. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.PluginSystem.html Point: Description: Represents a 2D point. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Point.html Polygon: Description: Represents a polygon. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Polygon.html Prepare: Description: Prepares assets for rendering. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Prepare.html Program: Description: Represents a shader program. Link: https://docs.rendleysdk.com/api-reference/classes/Pixi.Program.html ``` -------------------------------- ### Zod Array Schema Example Source: https://docs.rendleysdk.com/api-reference/classes/SubtitlesManager Example of defining and validating a Zod array schema. ```TypeScript import { z } from 'zod'; const numberArraySchema = z.array(z.number()); console.log(numberArraySchema.parse([1, 2, 3])); // [ 1, 2, 3 ] // console.log(numberArraySchema.parse([1, 'a', 3])); // Throws ZodError ``` -------------------------------- ### Zod Object Schema Example Source: https://docs.rendleysdk.com/api-reference/classes/SubtitlesManager Example of defining and validating a Zod object schema. ```TypeScript import { z } from 'zod'; const userSchema = z.object({ name: z.string().min(1), email: z.string().email(), age: z.number().positive().optional() }); const validUser = { name: 'John Doe', email: 'john.doe@example.com' }; const invalidUser = { name: '', email: 'invalid-email' }; console.log(userSchema.safeParse(validUser)); // { success: true, data: { name: 'John Doe', email: 'john.doe@example.com' } } console.log(userSchema.safeParse(invalidUser)); // { success: false, error: [ZodError] } ``` -------------------------------- ### Pixi BasePrepare Class Source: https://docs.rendleysdk.com/api-reference/variables/ClipSchema Documentation for the Pixi BasePrepare class. Handles the preparation of resources for rendering. ```APIDOC BasePrepare: Handles resource preparation for rendering. ```