Open3D (C++ API)  0.16.0
FilamentRenderToBuffer.h
Go to the documentation of this file.
1// ----------------------------------------------------------------------------
2// - Open3D: www.open3d.org -
3// ----------------------------------------------------------------------------
4// The MIT License (MIT)
5//
6// Copyright (c) 2018-2021 www.open3d.org
7//
8// Permission is hereby granted, free of charge, to any person obtaining a copy
9// of this software and associated documentation files (the "Software"), to deal
10// in the Software without restriction, including without limitation the rights
11// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12// copies of the Software, and to permit persons to whom the Software is
13// furnished to do so, subject to the following conditions:
14//
15// The above copyright notice and this permission notice shall be included in
16// all copies or substantial portions of the Software.
17//
18// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24// IN THE SOFTWARE.
25// ----------------------------------------------------------------------------
26
27#pragma once
28
30
32namespace filament {
33class Engine;
34class Renderer;
35class Scene;
36class SwapChain;
37} // namespace filament
39
40namespace open3d {
41namespace visualization {
42namespace rendering {
43
44class FilamentRenderer;
45class FilamentScene;
46class FilamentView;
47
49public:
50 // Use Renderer::CreateBufferRenderer to instantiate
51 // FilamentRenderToBuffer, unless you are NOT using
52 // open3d::visualization::gui or another FilamentRenderer instance.
53 explicit FilamentRenderToBuffer(filament::Engine& engine);
54 ~FilamentRenderToBuffer() override;
55
56 void Configure(const View* view,
57 Scene* scene,
58 int width,
59 int height,
60 int n_channels,
61 bool depth_image,
62 BufferReadyCallback cb) override;
64 View& GetView() override;
65
66 void Render() override;
67
68 // Renders the minimum necessary to get Filament to tick its rendering
69 // thread.
70 void RenderTick();
71
72private:
73 friend class FilamentRenderer;
74
75 filament::Engine& engine_;
76 filament::Renderer* renderer_ = nullptr;
77 filament::SwapChain* swapchain_ = nullptr;
78 FilamentView* view_ = nullptr;
79 FilamentScene* scene_ = nullptr;
80
81 std::size_t width_ = 0;
82 std::size_t height_ = 0;
83 std::size_t n_channels_ = 0;
84 std::uint8_t* buffer_ = nullptr;
85 std::size_t buffer_size_ = 0;
86 bool depth_image_ = false;
87
88 BufferReadyCallback callback_;
89 bool frame_done_ = true;
90 bool pending_ = false;
91
92 static void ReadPixelsCallback(void* buffer, size_t size, void* user);
93 void CopySettings(const View* view);
94};
95
96} // namespace rendering
97} // namespace visualization
98} // namespace open3d
Definition: FilamentRenderToBuffer.h:48
void SetDimensions(std::uint32_t width, std::uint32_t height) override
Definition: FilamentRenderToBuffer.cpp:130
~FilamentRenderToBuffer() override
Definition: FilamentRenderToBuffer.cpp:69
void Configure(const View *view, Scene *scene, int width, int height, int n_channels, bool depth_image, BufferReadyCallback cb) override
Definition: FilamentRenderToBuffer.cpp:83
void Render() override
Definition: FilamentRenderToBuffer.cpp:191
FilamentRenderToBuffer(filament::Engine &engine)
Definition: FilamentRenderToBuffer.cpp:64
void RenderTick()
Definition: FilamentRenderToBuffer.cpp:222
View & GetView() override
Definition: FilamentRenderToBuffer.cpp:169
std::function< void(const Buffer &)> BufferReadyCallback
Definition: RenderToBuffer.h:50
int width
Definition: FilePCD.cpp:71
int size
Definition: FilePCD.cpp:59
int height
Definition: FilePCD.cpp:72
Definition: FilamentEngine.h:31
const char const char value recording_handle imu_sample recording_handle uint8_t size_t data_size k4a_record_configuration_t config target_format k4a_capture_t capture_handle k4a_imu_sample_t imu_sample playback_handle k4a_logging_message_cb_t void min_level device_handle k4a_imu_sample_t timeout_in_ms capture_handle capture_handle capture_handle image_handle temperature_c k4a_image_t image_handle uint8_t image_handle image_handle image_handle image_handle uint32_t
Definition: K4aPlugin.cpp:567
const char const char value recording_handle imu_sample recording_handle uint8_t size_t data_size k4a_record_configuration_t config target_format k4a_capture_t capture_handle k4a_imu_sample_t imu_sample playback_handle k4a_logging_message_cb_t void min_level device_handle k4a_imu_sample_t timeout_in_ms capture_handle capture_handle capture_handle image_handle temperature_c k4a_image_t image_handle uint8_t image_handle image_handle image_handle image_handle image_handle timestamp_usec white_balance image_handle k4a_device_configuration_t config device_handle char size_t serial_number_size bool int32_t int32_t int32_t int32_t k4a_color_control_mode_t default_mode value const const k4a_calibration_t calibration char const const k4a_calibration_t calibration const k4a_calibration_t const k4a_float2_t const const const k4a_float3_t int valid const k4a_calibration_t const k4a_float2_t const const const k4a_float2_t int valid transformation_handle const depth_image
Definition: K4aPlugin.cpp:841
const char const char value recording_handle imu_sample recording_handle uint8_t size_t data_size k4a_record_configuration_t config target_format k4a_capture_t capture_handle k4a_imu_sample_t imu_sample playback_handle k4a_logging_message_cb_t void min_level device_handle k4a_imu_sample_t timeout_in_ms capture_handle capture_handle capture_handle image_handle temperature_c k4a_image_t image_handle uint8_t image_handle image_handle image_handle image_handle image_handle timestamp_usec white_balance image_handle k4a_device_configuration_t config device_handle char size_t serial_number_size bool int32_t int32_t int32_t int32_t k4a_color_control_mode_t default_mode value const const k4a_calibration_t calibration char size_t
Definition: K4aPlugin.cpp:738
void ReadPixelsCallback(void *buffer, size_t buffer_size, void *user)
Definition: FilamentScene.cpp:1819
Definition: PinholeCameraIntrinsic.cpp:35