Open3D (C++ API)  0.16.1
RenderToBuffer.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
29#include <cstdint>
30#include <functional>
31#include <memory>
32
33namespace open3d {
34namespace visualization {
35namespace rendering {
36
37class Scene;
38class View;
39
41public:
42 struct Buffer {
46 const std::uint8_t* bytes = nullptr;
48 };
49
50 using BufferReadyCallback = std::function<void(const Buffer&)>;
51
52 virtual ~RenderToBuffer() = default;
53
54 // Sets a callback that will be called after rendering is finished
55 // and after the BufferReadyCallback from Configure() is finished.
56 // This callback can be used to deallocate the object. In particular,
57 // SetCleanupCallback([](RenderToBuffer *self) { delete self; });
58 // is valid.
59 void SetCleanupCallback(std::function<void(RenderToBuffer*)> cb) {
61 }
62
63 // BufferReadyCallback does not need to free Buffer::bytes.
64 // It should also not cache the pointer.
65 virtual void Configure(const View* view,
66 Scene* scene,
67 int width,
68 int height,
69 int n_channels,
70 bool depth_image,
71 BufferReadyCallback cb) = 0;
73 virtual View& GetView() = 0;
74
75 virtual void Render() = 0;
76
77protected:
79};
80
81} // namespace rendering
82} // namespace visualization
83} // namespace open3d
void SetCleanupCallback(std::function< void(RenderToBuffer *)> cb)
Definition: RenderToBuffer.h:59
virtual void Configure(const View *view, Scene *scene, int width, int height, int n_channels, bool depth_image, BufferReadyCallback cb)=0
std::function< void(RenderToBuffer *)> cleanup_callback_
Definition: RenderToBuffer.h:78
virtual void SetDimensions(std::uint32_t width, std::uint32_t height)=0
std::function< void(const Buffer &)> BufferReadyCallback
Definition: RenderToBuffer.h:50
int width
Definition: FilePCD.cpp:71
int height
Definition: FilePCD.cpp:72
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 void
Definition: K4aPlugin.cpp:269
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
Definition: PinholeCameraIntrinsic.cpp:35
std::size_t height
Definition: RenderToBuffer.h:44
std::size_t width
Definition: RenderToBuffer.h:43
std::size_t size
Definition: RenderToBuffer.h:47
const std::uint8_t * bytes
Definition: RenderToBuffer.h:46
std::size_t n_channels
Definition: RenderToBuffer.h:45