vtkWebGPULight.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkWebGPULight_h
#define vtkWebGPULight_h

#include "vtkLight.h"

#include "vtkRenderingWebGPUModule.h" // For export macro
#include "vtkWrappingHints.h"         // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkRenderer;
class vtkCamera;
class vtkOverrideAttribute;
class VTKRENDERINGWEBGPU_EXPORT VTK_MARSHALAUTO vtkWebGPULight : public vtkLight
{
public:
  static vtkWebGPULight* New();
  VTK_NEWINSTANCE
  static vtkOverrideAttribute* CreateOverrideAttributes();
  vtkTypeMacro(vtkWebGPULight, vtkLight);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void CacheLightInformation(vtkRenderer* renderer, vtkCamera* camera);
  inline const void* GetCachedLightInformation() { return &(this->CachedLightInfo); }
  static std::size_t GetCacheSizeBytes() { return sizeof(LightInfo); }

  void Render(vtkRenderer*, int) override;

protected:
  vtkWebGPULight() = default;
  ~vtkWebGPULight() override = default;

  struct LightInfo
  {
    // Must be 80 bytes to match WGSL SceneLight struct stride.
    // The 12-byte padding needed to align the first element after the 4-byte count
    // is written once in WriteLightsBuffer(), not per-light.
    // 0 : deferred, 1 : headlight, 2 : lightkit, 3 : positional
    vtkTypeUInt32 Type = 0;
    // 0 : not positional, 1 : positional
    vtkTypeUInt32 Positional = 0;
    vtkTypeFloat32 ConeAngle = 0;
    vtkTypeFloat32 Exponent = 0;
    vtkTypeFloat32 Color[4] = {};
    vtkTypeFloat32 DirectionVC[4] = {}; // normalized
    vtkTypeFloat32 PositionVC[4] = {};
    vtkTypeFloat32 Attenuation[4] = {};
  };
  LightInfo CachedLightInfo;

private:
  vtkWebGPULight(const vtkWebGPULight&) = delete;
  void operator=(const vtkWebGPULight&) = delete;
};

#define vtkWebGPULight_OVERRIDE_ATTRIBUTES vtkWebGPULight::CreateOverrideAttributes()
VTK_ABI_NAMESPACE_END
#endif