xref: /aosp_15_r20/external/skia/src/core/SkDrawShadowInfo.h (revision c8dee2aa9b3f27cf6c858bd81872bdeb2c07ed17)
1 /*
2  * Copyright 2017 Google Inc.
3  *
4  * Use of this source code is governed by a BSD-style license that can be
5  * found in the LICENSE file.
6  */
7 
8 #ifndef SkDrawShadowInfo_DEFINED
9 #define SkDrawShadowInfo_DEFINED
10 
11 #include "include/core/SkColor.h"
12 #include "include/core/SkPoint.h"
13 #include "include/core/SkPoint3.h"
14 #include "include/core/SkScalar.h"
15 #include "include/private/base/SkAssert.h"
16 #include "include/private/base/SkFloatingPoint.h"
17 #include "include/private/base/SkTPin.h"
18 
19 #include <algorithm>
20 #include <cstdint>
21 
22 class SkMatrix;
23 class SkPath;
24 struct SkRect;
25 
26 struct SkDrawShadowRec {
27     SkPoint3    fZPlaneParams;
28     SkPoint3    fLightPos;
29     SkScalar    fLightRadius;
30     SkColor     fAmbientColor;
31     SkColor     fSpotColor;
32     uint32_t    fFlags;
33 };
34 
35 namespace SkDrawShadowMetrics {
36 
37 static constexpr auto kAmbientHeightFactor = 1.0f / 128.0f;
38 static constexpr auto kAmbientGeomFactor = 64.0f;
39 // Assuming that we have a light height of 600 for the spot shadow,
40 // the spot values will reach their maximum at a height of approximately 292.3077.
41 // We'll round up to 300 to keep it simple.
42 static constexpr auto kMaxAmbientRadius = 300*kAmbientHeightFactor*kAmbientGeomFactor;
43 
divide_and_pin(float numer,float denom,float min,float max)44 static inline float divide_and_pin(float numer, float denom, float min, float max) {
45     float result = SkTPin(sk_ieee_float_divide(numer, denom), min, max);
46     // ensure that SkTPin handled non-finites correctly
47     SkASSERT(result >= min && result <= max);
48     return result;
49 }
50 
AmbientBlurRadius(SkScalar height)51 inline SkScalar AmbientBlurRadius(SkScalar height) {
52     return std::min(height*kAmbientHeightFactor*kAmbientGeomFactor, kMaxAmbientRadius);
53 }
54 
AmbientRecipAlpha(SkScalar height)55 inline SkScalar AmbientRecipAlpha(SkScalar height) {
56     return 1.0f + std::max(height*kAmbientHeightFactor, 0.0f);
57 }
58 
SpotBlurRadius(SkScalar occluderZ,SkScalar lightZ,SkScalar lightRadius)59 inline SkScalar SpotBlurRadius(SkScalar occluderZ, SkScalar lightZ, SkScalar lightRadius) {
60     return lightRadius*divide_and_pin(occluderZ, lightZ - occluderZ, 0.0f, 0.95f);
61 }
62 
GetSpotParams(SkScalar occluderZ,SkScalar lightX,SkScalar lightY,SkScalar lightZ,SkScalar lightRadius,SkScalar * blurRadius,SkScalar * scale,SkVector * translate)63 inline void GetSpotParams(SkScalar occluderZ, SkScalar lightX, SkScalar lightY, SkScalar lightZ,
64                           SkScalar lightRadius,
65                           SkScalar* blurRadius, SkScalar* scale, SkVector* translate) {
66     SkScalar zRatio = divide_and_pin(occluderZ, lightZ - occluderZ, 0.0f, 0.95f);
67     *blurRadius = lightRadius*zRatio;
68     *scale = divide_and_pin(lightZ, lightZ - occluderZ, 1.0f, 1.95f);
69     *translate = SkVector::Make(-zRatio * lightX, -zRatio * lightY);
70 }
71 
GetDirectionalParams(SkScalar occluderZ,SkScalar lightX,SkScalar lightY,SkScalar lightZ,SkScalar lightRadius,SkScalar * blurRadius,SkScalar * scale,SkVector * translate)72 inline void GetDirectionalParams(SkScalar occluderZ, SkScalar lightX, SkScalar lightY,
73                                  SkScalar lightZ, SkScalar lightRadius,
74                                  SkScalar* blurRadius, SkScalar* scale, SkVector* translate) {
75     *blurRadius = lightRadius*occluderZ;
76     *scale = 1;
77     // Max z-ratio is "max expected elevation"/"min allowable z"
78     constexpr SkScalar kMaxZRatio = 64/SK_ScalarNearlyZero;
79     SkScalar zRatio = divide_and_pin(occluderZ, lightZ, 0.0f, kMaxZRatio);
80     *translate = SkVector::Make(-zRatio * lightX, -zRatio * lightY);
81 }
82 
83 // Create the transformation to apply to a path to get its base shadow outline, given the light
84 // parameters and the path's 3D transformation (given by ctm and zPlaneParams).
85 // Also computes the blur radius to apply the transformed outline.
86 bool GetSpotShadowTransform(const SkPoint3& lightPos, SkScalar lightRadius,
87                             const SkMatrix& ctm, const SkPoint3& zPlaneParams,
88                             const SkRect& pathBounds, bool directional,
89                             SkMatrix* shadowTransform, SkScalar* radius);
90 
91 // get bounds prior to the ctm being applied
92 void GetLocalBounds(const SkPath&, const SkDrawShadowRec&, const SkMatrix& ctm, SkRect* bounds);
93 
94 }  // namespace SkDrawShadowMetrics
95 
96 #endif
97