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

GSOC23: Renderer Docs #104

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Conversation

BharatSahlot
Copy link

@BharatSahlot BharatSahlot commented May 23, 2023

As part of my GSOC project synfig/synfig#3017, I wanted to write documentation explaining the Rendering Code. My goal is to make it easier for new developers to understand the rendering code. I am not explaining functions, I am explaining the concepts, the trickier parts and how they are used together.

Pages:

  • Introduction
  • Target and Surface
  • Layers and Tasks
  • Render Engine and Queue
  • Optimizers

@BharatSahlot
Copy link
Author

@ice0 @rodolforg

Hi! Can you please go through the pages I have pushed? It's still a work in progress, and I want to make sure I'm on the right track before proceeding with the remaining pages.

Thanks!

docs/renderer_docs/introduction.rst Outdated Show resolved Hide resolved
docs/renderer_docs/introduction.rst Show resolved Hide resolved
docs/renderer_docs/introduction.rst Outdated Show resolved Hide resolved
docs/renderer_docs/introduction.rst Outdated Show resolved Hide resolved
docs/renderer_docs/target_surface.rst Outdated Show resolved Hide resolved
docs/renderer_docs/target_surface.rst Outdated Show resolved Hide resolved
@BharatSahlot
Copy link
Author

@ice0 I added a section for special tasks, but I am not sure about TaskSurface. I think its used for saving intermediate results to some surface?

@BharatSahlot BharatSahlot requested a review from ice0 June 4, 2023 14:52
Copy link
Contributor

@rodolforg rodolforg left a comment

Choose a reason for hiding this comment

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

Some typos

docs/renderer.rst Outdated Show resolved Hide resolved
docs/renderer_docs/introduction.rst Outdated Show resolved Hide resolved
docs/renderer_docs/introduction.rst Outdated Show resolved Hide resolved
docs/renderer_docs/introduction.rst Outdated Show resolved Hide resolved
docs/renderer_docs/optimizers.rst Outdated Show resolved Hide resolved
docs/renderer_docs/render_queue.rst Outdated Show resolved Hide resolved
docs/renderer_docs/render_queue.rst Outdated Show resolved Hide resolved
docs/renderer_docs/render_queue.rst Outdated Show resolved Hide resolved
docs/renderer_docs/render_queue.rst Outdated Show resolved Hide resolved
@rodolforg
Copy link
Contributor

but I am not sure about TaskSurface. I think its used for saving intermediate results to some surface?

TaskSurface is used by... bitmap layers (Layer_Bitmap , Import, etc.)?

@BharatSahlot BharatSahlot marked this pull request as ready for review June 21, 2023 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants