ai_filters.h

Go to the documentation of this file.

// Copyright 2021 Autodesk, Inc.  All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
 
#pragma once
#include "ai_nodes.h"
#include "ai_vector.h"
#include <stdint.h> // uint32_t etc
 
// forward declaration
struct AtAOVSampleIterator;
 
struct AtFilterNodeMethods {
   uint8_t (*FilterOutputType)(const AtNode*, uint8_t);
   void    (*FilterPixel)(AtNode*, AtAOVSampleIterator*, void*, uint8_t);
};
 
#define AI_FILTER_NODE_EXPORT_METHODS(tag)      \
AI_INSTANCE_COMMON_METHODS                      \
filter_output_type;                             \
filter_pixel;                                   \
static AtFilterNodeMethods ai_filter_mtds = {   \
   FilterOutputType,                            \
   FilterPixel                                  \
};                                              \
static AtNodeMethods ai_node_mtds = {           \
   &ai_common_mtds,                             \
   &ai_filter_mtds                              \
};                                              \
const AtNodeMethods *tag = &ai_node_mtds;
 
#define filter_output_type \
static uint8_t FilterOutputType(const AtNode* node, uint8_t input_type)
 
#define filter_pixel \
static void FilterPixel(AtNode* node, AtAOVSampleIterator* iterator, void* data_out, uint8_t data_type)
 
/* \}*/
 
AI_API void AiFilterInitialize(AtNode* node, bool requires_depth, const char** required_aovs);
AI_API void AiFilterUpdate(AtNode* node, float width);
/* \}*/
 
AI_API         void      AiAOVSampleIteratorInitPixel(AtAOVSampleIterator* iter, int x, int y);
AI_API         void      AiAOVSampleIteratorGetPixel(AtAOVSampleIterator* iter, int &x, int &y);
AI_API         void      AiAOVSampleIteratorReset(AtAOVSampleIterator* iter);
AI_API         bool      AiAOVSampleIteratorGetNext(AtAOVSampleIterator* iter);
AI_API         bool      AiAOVSampleIteratorGetNextDepth(AtAOVSampleIterator* iter);
AI_API AI_PURE AtVector2 AiAOVSampleIteratorGetOffset(const AtAOVSampleIterator* iter);
AI_API AI_PURE float     AiAOVSampleIteratorGetInvDensity(const AtAOVSampleIterator* iter);
AI_API AI_PURE int       AiAOVSampleIteratorGetDepth(const AtAOVSampleIterator* iter);
AI_API AI_PURE bool      AiAOVSampleIteratorHasValue(const AtAOVSampleIterator* iter);
AI_API AI_PURE bool      AiAOVSampleIteratorHasAOVValue(const AtAOVSampleIterator* iter, AtString name, uint8_t type);
AI_API AI_PURE AtString  AiAOVSampleIteratorGetAOVName(const AtAOVSampleIterator* iter);
/* \}*/
 
AI_API AI_PURE bool         AiAOVSampleIteratorGetBool  (const AtAOVSampleIterator* iter);
AI_API AI_PURE int          AiAOVSampleIteratorGetInt   (const AtAOVSampleIterator* iter);
AI_API AI_PURE unsigned int AiAOVSampleIteratorGetUInt  (const AtAOVSampleIterator* iter);
AI_API AI_PURE float        AiAOVSampleIteratorGetFlt   (const AtAOVSampleIterator* iter);
AI_API AI_PURE AtRGB        AiAOVSampleIteratorGetRGB   (const AtAOVSampleIterator* iter);
AI_API AI_PURE AtRGBA       AiAOVSampleIteratorGetRGBA  (const AtAOVSampleIterator* iter);
AI_API AI_PURE AtVector     AiAOVSampleIteratorGetVec   (const AtAOVSampleIterator* iter);
AI_API AI_PURE AtVector2    AiAOVSampleIteratorGetVec2  (const AtAOVSampleIterator* iter);
AI_API AI_PURE AtMatrix     AiAOVSampleIteratorGetMatrix(const AtAOVSampleIterator* iter);
AI_API AI_PURE const void*  AiAOVSampleIteratorGetPtr   (const AtAOVSampleIterator* iter);
/* \}*/
 
AI_API AI_PURE bool         AiAOVSampleIteratorGetAOVBool  (const AtAOVSampleIterator* iter, const AtString name);
AI_API AI_PURE int          AiAOVSampleIteratorGetAOVInt   (const AtAOVSampleIterator* iter, const AtString name);
AI_API AI_PURE unsigned int AiAOVSampleIteratorGetAOVUInt  (const AtAOVSampleIterator* iter, const AtString name);
AI_API AI_PURE float        AiAOVSampleIteratorGetAOVFlt   (const AtAOVSampleIterator* iter, const AtString name);
AI_API AI_PURE AtRGB        AiAOVSampleIteratorGetAOVRGB   (const AtAOVSampleIterator* iter, const AtString name);
AI_API AI_PURE AtRGBA       AiAOVSampleIteratorGetAOVRGBA  (const AtAOVSampleIterator* iter, const AtString name);
AI_API AI_PURE AtVector     AiAOVSampleIteratorGetAOVVec   (const AtAOVSampleIterator* iter, const AtString name);
AI_API AI_PURE AtVector2    AiAOVSampleIteratorGetAOVVec2  (const AtAOVSampleIterator* iter, const AtString name);
AI_API AI_PURE AtMatrix     AiAOVSampleIteratorGetAOVMatrix(const AtAOVSampleIterator* iter, const AtString name);
AI_API AI_PURE const void*  AiAOVSampleIteratorGetAOVPtr   (const AtAOVSampleIterator* iter, const AtString name);
/* \}*/
 
/*\}*/