vart_overlay.hpp

Go to the documentation of this file.

/*
 * Copyright 2024-2026 Advanced Micro Devices Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include "vart_device.hpp"
#include "vart_overlay_types.hpp"
#include "vart_videoframe.hpp"
 
namespace vart {
 
class OverlayImplBase;
 
class Overlay {
 public:
  Overlay() = delete;
 
  Overlay(OverlayImplType overlay_impl_type, std::shared_ptr<Device> device);
 
  Overlay(std::shared_ptr<OverlayImplBase> ptr);
 
  const std::shared_ptr<OverlayImplBase>& get_pimpl_handle() const;
 
  void draw_overlay(VideoFrame& frame, OverlayShapeInfo& shape_info);
 
 private:
  std::shared_ptr<OverlayImplBase> pimpl;  
};
 
}  // namespace vart