Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated engine migration page with ShaderMaterial changes #702

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updated engine migration page with ShaderMaterial changes #702

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/user-manual/engine/migrations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ The PlayCanvas Engine is continually evolving, and its updates occasionally intr

This guide provides an overview of all major breaking changes across releases, offering users a helpful resource for migrating their code to newer versions.

It’s advisable to use the debug version of the engine when troubleshooting issues, as it provides logs for deprecated messages, warnings, and errors related to incorrect usage.

## Migration from 1.75.0 to 2.4.0

The migration from major version 1 to major version 2 is a substantial update, introducing numerous breaking changes.
Expand All @@ -33,6 +35,10 @@ Numerous deprecated functions that provided backward compatibility have been rem

The BasicMaterial has been removed. To achieve equivalent functionality, you can use a StandardMaterial with the emissive color or emissive map set as a replacement.

#### Shader Material

If you've received error `Material class cannot be instantiated, use ShaderMaterial instead`, this indicates the need to modify your code use ShaderMaterial instead. Details description and an example can be found [here](https://github.com/playcanvas/engine/pull/6831).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you've received error `Material class cannot be instantiated, use ShaderMaterial instead`, this indicates the need to modify your code use ShaderMaterial instead. Details description and an example can be found [here](https://github.com/playcanvas/engine/pull/6831).
If you've received the error `Material class cannot be instantiated, use ShaderMaterial instead`, this indicates the need to modify your code to use `ShaderMaterial` instead. Detailed description and an example can be found [here](https://github.com/playcanvas/engine/pull/6831).


#### Rendering to a texture

When rendering to a texture, the deprecated method of configuring the RenderTarget on the Layer has been fully removed. The RenderTarget must now be set directly on the camera instead.
Expand Down