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.

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

Document CameraFeed platform limitations #100449

Merged
merged 1 commit into from
Dec 17, 2024

Conversation

tetrapod00
Copy link
Contributor

Fixes godotengine/godot-docs#9530.

CameraServer says:

[b]Note:[/b] This class is currently only implemented on Linux, macOS, and iOS, on other platforms no [CameraFeed]s will be available. To get a [CameraFeed] on iOS, the camera plugin from [url=https://github.com/godotengine/godot-ios-plugins]godot-ios-plugins[/url] is required.

Rather than copy the whole note, I listed the supported platforms and linked to CameraServer to fully document the limitations. Alternately I could copy the note entirely; not sure which is better to be translation and maintenance friendly.

@tetrapod00 tetrapod00 added this to the 4.x milestone Dec 15, 2024
@tetrapod00 tetrapod00 requested a review from a team as a code owner December 15, 2024 20:27
@Mickeon
Copy link
Contributor

Mickeon commented Dec 16, 2024

You may want to copy the entire note because the iOS case is pretty... notable.

not sure which is better to be translation and maintenance friendly.

It is unfortunate that we don't have snippets of documentation that are easier to maintain, but it is what it is for now.

@tetrapod00 tetrapod00 force-pushed the camera-feed-limitation branch from 5368d87 to 0480c2c Compare December 16, 2024 15:30
@tetrapod00
Copy link
Contributor Author

I duplicated the note exactly. Since I was already doing so, I made a minor change to the string in both places.

@Mickeon Mickeon modified the milestones: 4.x, 4.4 Dec 16, 2024
@akien-mga akien-mga merged commit 4b22e97 into godotengine:master Dec 17, 2024
20 checks passed
@akien-mga
Copy link
Member

Thanks!

@tetrapod00 tetrapod00 deleted the camera-feed-limitation branch December 17, 2024 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

camerafeed only currently works with IOS
3 participants