docs(unity): add RenderTextureImageSource docs#733
Open
damzobridge wants to merge 1 commit into
Open
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
lancesnider
reviewed
Jun 17, 2026
| @@ -0,0 +1,19 @@ | |||
| export const ExperimentalFeature = ({ defineSymbol = "RIVE_USING_EXPERIMENTAL", children }) => { | |||
Collaborator
There was a problem hiding this comment.
Nit pic - Does this need defineSymbol and children as props? Maybe you plan to use this in other scenarios?
Otherwise this can be just plain mdx.
lancesnider
reviewed
Jun 17, 2026
|
|
||
| | Mode | Behavior | | ||
| | --- | --- | | ||
| | `PerFrame` | Rebuild and re-push every frame. Default. Use for live sources such as video or camera output. | |
|
|
||
| | Mode | Behavior | | ||
| | --- | --- | | ||
| | `Auto` | Apply orientation and color fixes when needed. Default. | |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds Unity documentation describing how to bind live RenderTexture sources to Rive view model image properties via RenderTextureImageSource, and introduces a reusable MDX warning component to flag Unity APIs gated behind RIVE_USING_EXPERIMENTAL.
Changes:
- Adds a new reusable
ExperimentalFeatureMDX snippet that renders an “Experimental Feature” warning and explains how to enableRIVE_USING_EXPERIMENTAL. - Expands the Unity Data Binding “Images” documentation with a new Render Textures section, including usage guidance, limitations, and lifecycle recommendations for
RenderTextureImageSource.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| snippets/experimental-feature.mdx | Introduces a reusable warning component for experimental Unity features guarded by a scripting define. |
| game-runtimes/unity/data-binding.mdx | Adds a new Render Textures documentation section and imports/uses the new ExperimentalFeature snippet. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+21
to
23
| import { ExperimentalFeature } from "/snippets/experimental-feature.mdx"; | ||
| import { YouTube } from "/snippets/youtube.mdx"; | ||
| import { Demos } from "/snippets/demos.jsx"; |
Comment on lines
+526
to
+541
| ViewModelInstance viewModelInstance = riveWidget.StateMachine.ViewModelInstance; | ||
| if (viewModelInstance == null) | ||
| { | ||
| Debug.LogWarning("No ViewModelInstance on the widget."); | ||
| yield break; | ||
| } | ||
|
|
||
| ViewModelInstanceImageProperty imageProperty = | ||
| viewModelInstance.GetImageProperty(viewModelImagePath); | ||
| if (imageProperty == null) | ||
| { | ||
| Debug.LogWarning($"Image property '{viewModelImagePath}' not found."); | ||
| yield break; | ||
| } | ||
|
|
||
| imageProperty.SetFromRenderTextureImageSource(renderTextureSource); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds documentation for binding live Unity RenderTextures to Rive view model image properties using
RenderTextureImageSource.The new Render Textures section lives in the Unity data binding docs under Images, after the existing
ImageOutOfBandAssetexample.Also adds a reusable
ExperimentalFeaturecomponent for Unity APIs gated behindRIVE_USING_EXPERIMENTAL.