Deploying to master from @ gfx-rs/wgpu@d575c02 🚀

Author: cwfitzgerald

doc/search-index.js

@@ -330,78 +330,84 @@
 <a href=#330 id=330 data-nosnippet>330</a>        })
 <a href=#331 id=331 data-nosnippet>331</a>    }
 <a href=#332 id=332 data-nosnippet>332</a>
-<a href=#333 id=333 data-nosnippet>333</a>    <span class="doccomment">/// # Safety
+<a href=#333 id=333 data-nosnippet>333</a>    <span class="doccomment">/// Encode commands using the raw HAL command encoder.
 <a href=#334 id=334 data-nosnippet>334</a>    ///
-<a href=#335 id=335 data-nosnippet>335</a>    /// - The raw command encoder handle must not be manually destroyed
-<a href=#336 id=336 data-nosnippet>336</a>    </span><span class="kw">pub unsafe fn </span>command_encoder_as_hal_mut&lt;
-<a href=#337 id=337 data-nosnippet>337</a>        A: hal::Api,
-<a href=#338 id=338 data-nosnippet>338</a>        F: FnOnce(<span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;mut </span>A::CommandEncoder&gt;) -&gt; R,
-<a href=#339 id=339 data-nosnippet>339</a>        R,
-<a href=#340 id=340 data-nosnippet>340</a>    &gt;(
-<a href=#341 id=341 data-nosnippet>341</a>        <span class="kw-2">&amp;</span><span class="self">self</span>,
-<a href=#342 id=342 data-nosnippet>342</a>        id: CommandEncoderId,
-<a href=#343 id=343 data-nosnippet>343</a>        hal_command_encoder_callback: F,
-<a href=#344 id=344 data-nosnippet>344</a>    ) -&gt; R {
-<a href=#345 id=345 data-nosnippet>345</a>        <span class="macro">profiling::scope!</span>(<span class="string">"CommandEncoder::as_hal"</span>);
-<a href=#346 id=346 data-nosnippet>346</a>
-<a href=#347 id=347 data-nosnippet>347</a>        <span class="kw">let </span>hub = <span class="kw-2">&amp;</span><span class="self">self</span>.hub;
-<a href=#348 id=348 data-nosnippet>348</a>
-<a href=#349 id=349 data-nosnippet>349</a>        <span class="kw">let </span>cmd_enc = hub.command_encoders.get(id);
-<a href=#350 id=350 data-nosnippet>350</a>        <span class="kw">let </span><span class="kw-2">mut </span>cmd_buf_data = cmd_enc.data.lock();
-<a href=#351 id=351 data-nosnippet>351</a>        cmd_buf_data.record_as_hal_mut(|opt_cmd_buf| -&gt; R {
-<a href=#352 id=352 data-nosnippet>352</a>            hal_command_encoder_callback(opt_cmd_buf.and_then(|cmd_buf| {
-<a href=#353 id=353 data-nosnippet>353</a>                cmd_buf
-<a href=#354 id=354 data-nosnippet>354</a>                    .encoder
-<a href=#355 id=355 data-nosnippet>355</a>                    .open()
-<a href=#356 id=356 data-nosnippet>356</a>                    .ok()
-<a href=#357 id=357 data-nosnippet>357</a>                    .and_then(|encoder| encoder.as_any_mut().downcast_mut())
-<a href=#358 id=358 data-nosnippet>358</a>            }))
-<a href=#359 id=359 data-nosnippet>359</a>        })
-<a href=#360 id=360 data-nosnippet>360</a>    }
-<a href=#361 id=361 data-nosnippet>361</a>
-<a href=#362 id=362 data-nosnippet>362</a>    <span class="doccomment">/// # Safety
-<a href=#363 id=363 data-nosnippet>363</a>    ///
-<a href=#364 id=364 data-nosnippet>364</a>    /// - The raw queue handle must not be manually destroyed
-<a href=#365 id=365 data-nosnippet>365</a>    </span><span class="kw">pub unsafe fn </span>queue_as_hal&lt;A: hal::Api&gt;(
-<a href=#366 id=366 data-nosnippet>366</a>        <span class="kw-2">&amp;</span><span class="self">self</span>,
-<a href=#367 id=367 data-nosnippet>367</a>        id: QueueId,
-<a href=#368 id=368 data-nosnippet>368</a>    ) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw">impl </span>Deref&lt;Target = A::Queue&gt;&gt; {
-<a href=#369 id=369 data-nosnippet>369</a>        <span class="macro">profiling::scope!</span>(<span class="string">"Queue::as_hal"</span>);
-<a href=#370 id=370 data-nosnippet>370</a>
-<a href=#371 id=371 data-nosnippet>371</a>        <span class="kw">let </span>queue = <span class="self">self</span>.hub.queues.get(id);
-<a href=#372 id=372 data-nosnippet>372</a>
-<a href=#373 id=373 data-nosnippet>373</a>        SimpleResourceGuard::new(queue, <span class="kw">move </span>|queue| queue.raw().as_any().downcast_ref())
-<a href=#374 id=374 data-nosnippet>374</a>    }
-<a href=#375 id=375 data-nosnippet>375</a>
-<a href=#376 id=376 data-nosnippet>376</a>    <span class="doccomment">/// # Safety
-<a href=#377 id=377 data-nosnippet>377</a>    ///
-<a href=#378 id=378 data-nosnippet>378</a>    /// - The raw blas handle must not be manually destroyed
-<a href=#379 id=379 data-nosnippet>379</a>    </span><span class="kw">pub unsafe fn </span>blas_as_hal&lt;A: hal::Api&gt;(
-<a href=#380 id=380 data-nosnippet>380</a>        <span class="kw-2">&amp;</span><span class="self">self</span>,
-<a href=#381 id=381 data-nosnippet>381</a>        id: BlasId,
-<a href=#382 id=382 data-nosnippet>382</a>    ) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw">impl </span>Deref&lt;Target = A::AccelerationStructure&gt;&gt; {
-<a href=#383 id=383 data-nosnippet>383</a>        <span class="macro">profiling::scope!</span>(<span class="string">"Blas::as_hal"</span>);
-<a href=#384 id=384 data-nosnippet>384</a>
-<a href=#385 id=385 data-nosnippet>385</a>        <span class="kw">let </span>hub = <span class="kw-2">&amp;</span><span class="self">self</span>.hub;
-<a href=#386 id=386 data-nosnippet>386</a>
-<a href=#387 id=387 data-nosnippet>387</a>        <span class="kw">let </span>blas = hub.blas_s.get(id).get().ok()<span class="question-mark">?</span>;
-<a href=#388 id=388 data-nosnippet>388</a>
-<a href=#389 id=389 data-nosnippet>389</a>        SnatchableResourceGuard::new(blas)
-<a href=#390 id=390 data-nosnippet>390</a>    }
-<a href=#391 id=391 data-nosnippet>391</a>
-<a href=#392 id=392 data-nosnippet>392</a>    <span class="doccomment">/// # Safety
-<a href=#393 id=393 data-nosnippet>393</a>    ///
-<a href=#394 id=394 data-nosnippet>394</a>    /// - The raw tlas handle must not be manually destroyed
-<a href=#395 id=395 data-nosnippet>395</a>    </span><span class="kw">pub unsafe fn </span>tlas_as_hal&lt;A: hal::Api&gt;(
-<a href=#396 id=396 data-nosnippet>396</a>        <span class="kw-2">&amp;</span><span class="self">self</span>,
-<a href=#397 id=397 data-nosnippet>397</a>        id: TlasId,
-<a href=#398 id=398 data-nosnippet>398</a>    ) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw">impl </span>Deref&lt;Target = A::AccelerationStructure&gt;&gt; {
-<a href=#399 id=399 data-nosnippet>399</a>        <span class="macro">profiling::scope!</span>(<span class="string">"Tlas::as_hal"</span>);
-<a href=#400 id=400 data-nosnippet>400</a>
-<a href=#401 id=401 data-nosnippet>401</a>        <span class="kw">let </span>hub = <span class="kw-2">&amp;</span><span class="self">self</span>.hub;
-<a href=#402 id=402 data-nosnippet>402</a>
-<a href=#403 id=403 data-nosnippet>403</a>        <span class="kw">let </span>tlas = hub.tlas_s.get(id).get().ok()<span class="question-mark">?</span>;
-<a href=#404 id=404 data-nosnippet>404</a>
-<a href=#405 id=405 data-nosnippet>405</a>        SnatchableResourceGuard::new(tlas)
-<a href=#406 id=406 data-nosnippet>406</a>    }
-<a href=#407 id=407 data-nosnippet>407</a>}</code></pre></div></section></main></body></html>
+<a href=#335 id=335 data-nosnippet>335</a>    /// # Panics
+<a href=#336 id=336 data-nosnippet>336</a>    ///
+<a href=#337 id=337 data-nosnippet>337</a>    /// If the command encoder has already been used with the wgpu encoding API.
+<a href=#338 id=338 data-nosnippet>338</a>    ///
+<a href=#339 id=339 data-nosnippet>339</a>    /// # Safety
+<a href=#340 id=340 data-nosnippet>340</a>    ///
+<a href=#341 id=341 data-nosnippet>341</a>    /// - The raw command encoder handle must not be manually destroyed
+<a href=#342 id=342 data-nosnippet>342</a>    </span><span class="kw">pub unsafe fn </span>command_encoder_as_hal_mut&lt;
+<a href=#343 id=343 data-nosnippet>343</a>        A: hal::Api,
+<a href=#344 id=344 data-nosnippet>344</a>        F: FnOnce(<span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;mut </span>A::CommandEncoder&gt;) -&gt; R,
+<a href=#345 id=345 data-nosnippet>345</a>        R,
+<a href=#346 id=346 data-nosnippet>346</a>    &gt;(
+<a href=#347 id=347 data-nosnippet>347</a>        <span class="kw-2">&amp;</span><span class="self">self</span>,
+<a href=#348 id=348 data-nosnippet>348</a>        id: CommandEncoderId,
+<a href=#349 id=349 data-nosnippet>349</a>        hal_command_encoder_callback: F,
+<a href=#350 id=350 data-nosnippet>350</a>    ) -&gt; R {
+<a href=#351 id=351 data-nosnippet>351</a>        <span class="macro">profiling::scope!</span>(<span class="string">"CommandEncoder::as_hal"</span>);
+<a href=#352 id=352 data-nosnippet>352</a>
+<a href=#353 id=353 data-nosnippet>353</a>        <span class="kw">let </span>hub = <span class="kw-2">&amp;</span><span class="self">self</span>.hub;
+<a href=#354 id=354 data-nosnippet>354</a>
+<a href=#355 id=355 data-nosnippet>355</a>        <span class="kw">let </span>cmd_enc = hub.command_encoders.get(id);
+<a href=#356 id=356 data-nosnippet>356</a>        <span class="kw">let </span><span class="kw-2">mut </span>cmd_buf_data = cmd_enc.data.lock();
+<a href=#357 id=357 data-nosnippet>357</a>        cmd_buf_data.record_as_hal_mut(|opt_cmd_buf| -&gt; R {
+<a href=#358 id=358 data-nosnippet>358</a>            hal_command_encoder_callback(opt_cmd_buf.and_then(|cmd_buf| {
+<a href=#359 id=359 data-nosnippet>359</a>                cmd_buf
+<a href=#360 id=360 data-nosnippet>360</a>                    .encoder
+<a href=#361 id=361 data-nosnippet>361</a>                    .open()
+<a href=#362 id=362 data-nosnippet>362</a>                    .ok()
+<a href=#363 id=363 data-nosnippet>363</a>                    .and_then(|encoder| encoder.as_any_mut().downcast_mut())
+<a href=#364 id=364 data-nosnippet>364</a>            }))
+<a href=#365 id=365 data-nosnippet>365</a>        })
+<a href=#366 id=366 data-nosnippet>366</a>    }
+<a href=#367 id=367 data-nosnippet>367</a>
+<a href=#368 id=368 data-nosnippet>368</a>    <span class="doccomment">/// # Safety
+<a href=#369 id=369 data-nosnippet>369</a>    ///
+<a href=#370 id=370 data-nosnippet>370</a>    /// - The raw queue handle must not be manually destroyed
+<a href=#371 id=371 data-nosnippet>371</a>    </span><span class="kw">pub unsafe fn </span>queue_as_hal&lt;A: hal::Api&gt;(
+<a href=#372 id=372 data-nosnippet>372</a>        <span class="kw-2">&amp;</span><span class="self">self</span>,
+<a href=#373 id=373 data-nosnippet>373</a>        id: QueueId,
+<a href=#374 id=374 data-nosnippet>374</a>    ) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw">impl </span>Deref&lt;Target = A::Queue&gt;&gt; {
+<a href=#375 id=375 data-nosnippet>375</a>        <span class="macro">profiling::scope!</span>(<span class="string">"Queue::as_hal"</span>);
+<a href=#376 id=376 data-nosnippet>376</a>
+<a href=#377 id=377 data-nosnippet>377</a>        <span class="kw">let </span>queue = <span class="self">self</span>.hub.queues.get(id);
+<a href=#378 id=378 data-nosnippet>378</a>
+<a href=#379 id=379 data-nosnippet>379</a>        SimpleResourceGuard::new(queue, <span class="kw">move </span>|queue| queue.raw().as_any().downcast_ref())
+<a href=#380 id=380 data-nosnippet>380</a>    }
+<a href=#381 id=381 data-nosnippet>381</a>
+<a href=#382 id=382 data-nosnippet>382</a>    <span class="doccomment">/// # Safety
+<a href=#383 id=383 data-nosnippet>383</a>    ///
+<a href=#384 id=384 data-nosnippet>384</a>    /// - The raw blas handle must not be manually destroyed
+<a href=#385 id=385 data-nosnippet>385</a>    </span><span class="kw">pub unsafe fn </span>blas_as_hal&lt;A: hal::Api&gt;(
+<a href=#386 id=386 data-nosnippet>386</a>        <span class="kw-2">&amp;</span><span class="self">self</span>,
+<a href=#387 id=387 data-nosnippet>387</a>        id: BlasId,
+<a href=#388 id=388 data-nosnippet>388</a>    ) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw">impl </span>Deref&lt;Target = A::AccelerationStructure&gt;&gt; {
+<a href=#389 id=389 data-nosnippet>389</a>        <span class="macro">profiling::scope!</span>(<span class="string">"Blas::as_hal"</span>);
+<a href=#390 id=390 data-nosnippet>390</a>
+<a href=#391 id=391 data-nosnippet>391</a>        <span class="kw">let </span>hub = <span class="kw-2">&amp;</span><span class="self">self</span>.hub;
+<a href=#392 id=392 data-nosnippet>392</a>
+<a href=#393 id=393 data-nosnippet>393</a>        <span class="kw">let </span>blas = hub.blas_s.get(id).get().ok()<span class="question-mark">?</span>;
+<a href=#394 id=394 data-nosnippet>394</a>
+<a href=#395 id=395 data-nosnippet>395</a>        SnatchableResourceGuard::new(blas)
+<a href=#396 id=396 data-nosnippet>396</a>    }
+<a href=#397 id=397 data-nosnippet>397</a>
+<a href=#398 id=398 data-nosnippet>398</a>    <span class="doccomment">/// # Safety
+<a href=#399 id=399 data-nosnippet>399</a>    ///
+<a href=#400 id=400 data-nosnippet>400</a>    /// - The raw tlas handle must not be manually destroyed
+<a href=#401 id=401 data-nosnippet>401</a>    </span><span class="kw">pub unsafe fn </span>tlas_as_hal&lt;A: hal::Api&gt;(
+<a href=#402 id=402 data-nosnippet>402</a>        <span class="kw-2">&amp;</span><span class="self">self</span>,
+<a href=#403 id=403 data-nosnippet>403</a>        id: TlasId,
+<a href=#404 id=404 data-nosnippet>404</a>    ) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw">impl </span>Deref&lt;Target = A::AccelerationStructure&gt;&gt; {
+<a href=#405 id=405 data-nosnippet>405</a>        <span class="macro">profiling::scope!</span>(<span class="string">"Tlas::as_hal"</span>);
+<a href=#406 id=406 data-nosnippet>406</a>
+<a href=#407 id=407 data-nosnippet>407</a>        <span class="kw">let </span>hub = <span class="kw-2">&amp;</span><span class="self">self</span>.hub;
+<a href=#408 id=408 data-nosnippet>408</a>
+<a href=#409 id=409 data-nosnippet>409</a>        <span class="kw">let </span>tlas = hub.tlas_s.get(id).get().ok()<span class="question-mark">?</span>;
+<a href=#410 id=410 data-nosnippet>410</a>
+<a href=#411 id=411 data-nosnippet>411</a>        SnatchableResourceGuard::new(tlas)
+<a href=#412 id=412 data-nosnippet>412</a>    }
+<a href=#413 id=413 data-nosnippet>413</a>}</code></pre></div></section></main></body></html>