test/intern/cycles/kernel/light/spot.h

/* SPDX-FileCopyrightText: 2011-2022 Blender Foundation
 *
 * SPDX-License-Identifier: Apache-2.0 */

#pragma once

#include "kernel/light/common.h"

CCL_NAMESPACE_BEGIN

/* Transform vector to spot light's local coordinate system. */
ccl_device float3 spot_light_to_local(const ccl_global KernelSpotLight *spot, const float3 ray)
{
  return safe_normalize(make_float3(dot(ray, spot->scaled_axis_u),
                                    dot(ray, spot->scaled_axis_v),
                                    dot(ray, spot->dir * spot->inv_len_z)));
}

/* Compute spot light attenuation of a ray given in local coordinate system. */
ccl_device float spot_light_attenuation(const ccl_global KernelSpotLight *spot, const float3 ray)
{
  return smoothstepf((ray.z - spot->cos_half_spot_angle) * spot->spot_smooth);
}

ccl_device void spot_light_uv(const float3 ray,
                              const float half_cot_half_spot_angle,
                              ccl_private float *u,
                              ccl_private float *v)
{
  /* Ensures that the spot light projects the full image regardless of the spot angle. */
  const float factor = half_cot_half_spot_angle / ray.z;

  /* NOTE: Return barycentric coordinates in the same notation as Embree and OptiX. */
  *u = ray.y * factor + 0.5f;
  *v = -(ray.x + ray.y) * factor;
}

template<bool in_volume_segment>
ccl_device_inline bool spot_light_sample(const ccl_global KernelLight *klight,
                                         const float2 rand,
                                         const float3 P,
                                         const float3 N,
                                         const int shader_flags,
                                         ccl_private LightSample *ls)
{
  const float radius = klight->spot.radius;
  const float r_sq = sqr(klight->spot.radius);

  const float3 center = klight->co;

  float3 lightN = P - center;
  const float d_sq = len_squared(lightN);
  const float d = sqrtf(d_sq);
  lightN /= d;

  float cos_theta;
  ls->t = FLT_MAX;
  if (d_sq > r_sq) {
    const float one_minus_cos_half_spot_spread = 1.0f - klight->spot.cos_half_spot_angle;
    const float one_minus_cos_half_angle = sin_sqr_to_one_minus_cos(r_sq / d_sq);

    if (in_volume_segment || one_minus_cos_half_angle < one_minus_cos_half_spot_spread) {
      /* Sample visible part of the sphere. */
      ls->D = sample_uniform_cone(-lightN, one_minus_cos_half_angle, rand, &cos_theta, &ls->pdf);
    }
    else {
      /* Sample spread cone. */
      ls->D = sample_uniform_cone(
          -klight->spot.dir, one_minus_cos_half_spot_spread, rand, &cos_theta, &ls->pdf);

      if (!ray_sphere_intersect(P, ls->D, 0.0f, FLT_MAX, center, radius, &ls->P, &ls->t)) {
        /* Sampled direction does not intersect with the light. */
        return false;
      }
    }
  }
  else {
    const bool has_transmission = (shader_flags & SD_BSDF_HAS_TRANSMISSION);
    if (has_transmission) {
      ls->D = sample_uniform_sphere(rand);
      ls->pdf = M_1_2PI_F * 0.5f;
    }
    else {
      sample_cos_hemisphere(N, rand, &ls->D, &ls->pdf);
    }
    cos_theta = -dot(ls->D, lightN);
  }

  if (ls->t == FLT_MAX) {
    /* Law of cosines. */
    ls->t = d * cos_theta -
            copysignf(safe_sqrtf(r_sq - d_sq + d_sq * sqr(cos_theta)), d_sq - r_sq);
    ls->P = P + ls->D * ls->t;
  }
  else {
    /* Already computed when sampling the spread cone. */
  }

  const float3 local_ray = spot_light_to_local(&klight->spot, -ls->D);
  ls->eval_fac = klight->spot.eval_fac;
  if (d_sq > r_sq) {
    ls->eval_fac *= spot_light_attenuation(&klight->spot, local_ray);
  }

  if (!in_volume_segment && ls->eval_fac == 0.0f) {
    return false;
  }

  if (r_sq == 0) {
    /* Use intensity instead of radiance when the radius is zero. */
    ls->eval_fac /= sqr(ls->t);
    /* `ls->Ng` is not well-defined when the radius is zero, use the incoming direction instead. */
    ls->Ng = -ls->D;
  }
  else {
    ls->Ng = normalize(ls->P - center);
    /* Remap sampled point onto the sphere to prevent precision issues with small radius. */
    ls->P = ls->Ng * radius + center;
  }

  spot_light_uv(local_ray, klight->spot.half_cot_half_spot_angle, &ls->u, &ls->v);

  return true;
}

ccl_device_forceinline float spot_light_pdf(const float cos_half_spread,
                                            const float d_sq,
                                            const float r_sq,
                                            const float3 N,
                                            const float3 D,
                                            const uint32_t path_flag)
{
  if (d_sq > r_sq) {
    return M_1_2PI_F / min(sin_sqr_to_one_minus_cos(r_sq / d_sq), 1.0f - cos_half_spread);
  }

  const bool has_transmission = (path_flag & PATH_RAY_MIS_HAD_TRANSMISSION);
  return has_transmission ? M_1_2PI_F * 0.5f : pdf_cos_hemisphere(N, D);
}

ccl_device_forceinline void spot_light_mnee_sample_update(const ccl_global KernelLight *klight,
                                                          ccl_private LightSample *ls,
                                                          const float3 P,
                                                          const float3 N,
                                                          const uint32_t path_flag)
{
  ls->D = normalize_len(ls->P - P, &ls->t);

  const float3 local_ray = spot_light_to_local(&klight->spot, -ls->D);
  ls->eval_fac = klight->spot.eval_fac;

  const float radius = klight->spot.radius;

  if (radius > 0) {
    const float d_sq = len_squared(P - klight->co);
    const float r_sq = sqr(radius);
    const float t_sq = sqr(ls->t);

    ls->pdf = spot_light_pdf(klight->spot.cos_half_spot_angle, d_sq, r_sq, N, ls->D, path_flag);

    /* NOTE : preserve pdf in area measure. */
    ls->pdf *= 0.5f * fabsf(d_sq - r_sq - t_sq) / (radius * ls->t * t_sq);

    ls->Ng = normalize(ls->P - klight->co);

    if (d_sq > r_sq) {
      ls->eval_fac *= spot_light_attenuation(&klight->spot, local_ray);
    }
  }
  else {
    ls->Ng = -ls->D;

    ls->eval_fac *= spot_light_attenuation(&klight->spot, local_ray);

    /* PDF does not change. */
  }

  spot_light_uv(local_ray, klight->spot.half_cot_half_spot_angle, &ls->u, &ls->v);
}

ccl_device_inline bool spot_light_intersect(const ccl_global KernelLight *klight,
                                            const ccl_private Ray *ccl_restrict ray,
                                            ccl_private float *t)
{
  /* One sided. */
  if (dot(ray->D, ray->P - klight->co) >= 0.0f) {
    return false;
  }

  return point_light_intersect(klight, ray, t);
}

ccl_device_inline bool spot_light_sample_from_intersection(
    const ccl_global KernelLight *klight,
    ccl_private const Intersection *ccl_restrict isect,
    const float3 ray_P,
    const float3 ray_D,
    const float3 N,
    const uint32_t path_flag,
    ccl_private LightSample *ccl_restrict ls)
{
  const float d_sq = len_squared(ray_P - klight->co);
  const float r_sq = sqr(klight->spot.radius);

  ls->pdf = spot_light_pdf(klight->spot.cos_half_spot_angle, d_sq, r_sq, N, ray_D, path_flag);

  const float3 local_ray = spot_light_to_local(&klight->spot, -ray_D);
  ls->eval_fac = klight->spot.eval_fac;
  if (d_sq > r_sq) {
    ls->eval_fac *= spot_light_attenuation(&klight->spot, local_ray);
  }
  if (ls->eval_fac == 0) {
    return false;
  }

  ls->Ng = r_sq > 0 ? normalize(ls->P - klight->co) : -ray_D;

  spot_light_uv(local_ray, klight->spot.half_cot_half_spot_angle, &ls->u, &ls->v);

  return true;
}

template<bool in_volume_segment>
ccl_device_forceinline bool spot_light_tree_parameters(const ccl_global KernelLight *klight,
                                                       const float3 centroid,
                                                       const float3 P,
                                                       ccl_private float &cos_theta_u,
                                                       ccl_private float2 &distance,
                                                       ccl_private float3 &point_to_centroid)
{
  float dist_point_to_centroid;
  const float3 point_to_centroid_ = safe_normalize_len(centroid - P, &dist_point_to_centroid);

  const float radius = klight->spot.radius;
  cos_theta_u = (dist_point_to_centroid > radius) ? cos_from_sin(radius / dist_point_to_centroid) :
                                                    -1.0f;

  if (in_volume_segment) {
    return true;
  }

  distance = (dist_point_to_centroid > radius) ?
                 dist_point_to_centroid * make_float2(1.0f / cos_theta_u, 1.0f) :
                 one_float2() * radius / M_SQRT2_F;
  point_to_centroid = point_to_centroid_;

  return true;
}

CCL_NAMESPACE_END