@@ -12,32 +12,33 @@ but it can also be used as such in a standalone application.
12
12
WebRender currently depends on [FreeType](https://www.freetype.org/)
13
13
14
14
# Api Structure
15
- The main entry point to WebRender is the `webrender ::Renderer`.
15
+ The main entry point to WebRender is the [`crate ::Renderer`] .
16
16
17
- By calling `Renderer::new(...)` you get a `Renderer`, as well as a `RenderApiSender`.
18
- Your `Renderer` is responsible to render the previously processed frames onto the screen.
17
+ By calling [`Renderer::new(...)`](crate::Renderer::new) you get a [`Renderer`], as well as
18
+ a [`RenderApiSender`](api::RenderApiSender). Your [`Renderer`] is responsible to render the
19
+ previously processed frames onto the screen.
19
20
20
- By calling `yourRenderApiSender.create_api()`, you'll get a `RenderApi` instance,
21
- which is responsible for managing resources and documents. A worker thread is used internally
22
- to untie the workload from the application thread and therefore be able to make better use of
23
- multicore systems.
21
+ By calling [ `yourRenderApiSender.create_api()`](api::RenderApiSender::create_api) , you'll
22
+ get a [`RenderApi`](api::RenderApi) instance, which is responsible for managing resources
23
+ and documents. A worker thread is used internally to untie the workload from the application
24
+ thread and therefore be able to make better use of multicore systems.
24
25
25
26
## Frame
26
27
27
28
What is referred to as a `frame`, is the current geometry on the screen.
28
- A new Frame is created by calling [`set_display_list()`][newframe] on the `RenderApi`.
29
- When the geometry is processed, the application will be informed via a `RenderNotifier`,
30
- a callback which you employ with [set_render_notifier][notifier] on the `Renderer`
29
+ A new Frame is created by calling [`set_display_list()`](api::Transaction::set_display_list)
30
+ on the [`RenderApi`](api::RenderApi). When the geometry is processed, the application will be
31
+ informed via a [`RenderNotifier`](api::RenderNotifier), a callback which you pass to
32
+ [`Renderer::new`].
31
33
More information about [stacking contexts][stacking_contexts].
32
34
33
- `set_display_list()` also needs to be supplied with `BuiltDisplayList`s.
34
- These are obtained by finalizing a `DisplayListBuilder`. These are used to draw your geometry.
35
- But it doesn't only contain trivial geometry, it can also store another StackingContext, as
36
- they're nestable.
35
+ [`set_display_list()`](api::Transaction::set_display_list) also needs to be supplied with
36
+ [`BuiltDisplayList`](api::BuiltDisplayList)s. These are obtained by finalizing a
37
+ [`DisplayListBuilder`](api::DisplayListBuilder). These are used to draw your geometry. But it
38
+ doesn't only contain trivial geometry, it can also store another
39
+ [`StackingContext`](api::StackingContext), as they're nestable.
37
40
38
41
[stacking_contexts]: https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Positioning/Understanding_z_index/The_stacking_context
39
- [newframe]: ../webrender_api/struct.RenderApi.html#method.set_display_list
40
- [notifier]: renderer/struct.Renderer.html#method.set_render_notifier
41
42
*/
42
43
43
44
// Cribbed from the |matches| crate, for simplicity.
0 commit comments