bevy/crates/bevy_render/src
Brian Merchant e60f614a86 Documenting BufferVec. (#4673)
# Objective

Documents the `BufferVec` render resource.

`BufferVec` is a fairly low level object, that will likely be managed by a higher level API (e.g. through [`encase`](https://github.com/bevyengine/bevy/issues/4272)) in the future. For now, since it is still used by some simple 
example crates (e.g. [bevy-vertex-pulling](https://github.com/superdump/bevy-vertex-pulling)), it will be helpful
to provide some simple documentation on what `BufferVec` does.  

## Solution

I looked through Discord discussion on `BufferVec`, and found [a comment](https://discord.com/channels/691052431525675048/953222550568173580/956596218857918464 ) by @superdump to be particularly helpful, in the general discussion around `encase`. 

I have taken care to clarify where the data is stored (host-side), when the device-side buffer is created (through calls to `reserve`), and when data writes from host to device are scheduled (using `write_buffer` calls). 

---

## Changelog

- Added doc string for `BufferVec` and two of its methods: `reserve` and `write_buffer`. 


Co-authored-by: Brian Merchant <bhmerchant@gmail.com>
2022-06-28 04:09:04 +00:00
..
camera bevy_reflect: put serialize into external ReflectSerialize type (#4782) 2022-06-20 17:18:58 +00:00
color bevy_reflect: put serialize into external ReflectSerialize type (#4782) 2022-06-20 17:18:58 +00:00
mesh bevy_render: Add attributes and attributes_mut methods to Mesh. (#3927) 2022-06-15 06:29:52 +00:00
primitives Faster assign lights to clusters (#4345) 2022-04-15 02:53:20 +00:00
render_graph Camera Driven Rendering (#4745) 2022-06-02 00:12:17 +00:00
render_phase Allow unbatched render phases to use unstable sorts (#5049) 2022-06-23 10:52:49 +00:00
render_resource Documenting BufferVec. (#4673) 2022-06-28 04:09:04 +00:00
renderer diagnostics: meaningful error when graph node has wrong number of inputs (#4924) 2022-06-06 15:47:52 +00:00
texture Default image sampler doc fix (#5047) 2022-06-26 02:26:29 +00:00
view Add some docs about lowspec rendering (#5091) 2022-06-25 16:22:28 +00:00
extract_component.rs ExtractResourcePlugin (#3745) 2022-05-30 18:36:03 +00:00
extract_resource.rs ExtractResourcePlugin (#3745) 2022-05-30 18:36:03 +00:00
lib.rs Change default Image FilterMode to Linear (#4465) 2022-06-11 09:13:37 +00:00
render_asset.rs Clippy improvements (#4665) 2022-05-31 01:38:07 +00:00
settings.rs Add some docs about lowspec rendering (#5091) 2022-06-25 16:22:28 +00:00