Core/TemporalEffects.h

   1 //
   2 // Copyright (c) Microsoft. All rights reserved.
   3 // This code is licensed under the MIT License (MIT).
   4 // THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF
   5 // ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY
   6 // IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR
   7 // PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.
   8 //
   9 // Developed by Minigraph
  10 //
  11 // Author:  James Stanard
  12 //
  13
  14 #pragma once
  15
  16 #include "EngineTuning.h"
  17
  18 class CommandContext;
  19 class DepthBuffer;
  20
  21 namespace TemporalEffects
  22 {
  23     // Temporal antialiasing involves jittering sample positions and accumulating color over time to
  24     // effectively supersample the image.
  25     extern BoolVar EnableTAA;
  26
  27     void Initialize( void );
  28
  29     void Shutdown( void );
  30
  31     // Call once per frame to increment the internal frame counter and, in the case of TAA, choosing the next
  32     // jittered sample position.
  33     void Update( uint64_t FrameIndex );
  34
  35     // Returns whether the frame is odd or even
  36     uint32_t GetFrameIndexMod2( void );
  37
  38     // Jitter values are neutral at 0.5 and vary from [0, 1).  Jittering only occurs when temporal antialiasing
  39     // is enabled.  You can use these values to jitter your viewport or projection matrix.
  40     void GetJitterOffset( float& JitterX, float& JitterY );
  41
  42     void ClearHistory(CommandContext& Context);
  43
  44     void ResolveImage(CommandContext& Context);
  45
  46 }