ai_drivers.h

Go to the documentation of this file.

// Copyright 2022 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_api.h"
#include "ai_bbox.h"
#include <stdint.h> // uint32_t etc
 
// forward declaration
struct AtOutputIterator;
struct AtAOVSampleIterator;
 
struct AtDriverNodeMethods {
   bool         (*DriverSupportsPixelType)(const AtNode*, uint8_t);
   const char** (*DriverExtension)();
   void         (*DriverOpen)(AtNode*, struct AtOutputIterator*, AtBBox2, AtBBox2, int);
   bool         (*DriverNeedsBucket)(AtNode*, int, int, int, int, uint16_t);
   void         (*DriverPrepareBucket)(AtNode*, int, int, int, int, uint16_t);
   void         (*DriverProcessBucket)(AtNode*, struct AtOutputIterator*, struct AtAOVSampleIterator*, int, int, int, int, uint16_t);
   void         (*DriverWriteBucket)(AtNode*, struct AtOutputIterator*, struct AtAOVSampleIterator*, int, int, int, int);
   void         (*DriverClose)(AtNode*, struct AtOutputIterator*);
};
 
#define AI_DRIVER_NODE_EXPORT_METHODS(tag)         \
AI_INSTANCE_COMMON_METHODS                         \
driver_supports_pixel_type;                        \
driver_extension;                                  \
driver_open;                                       \
driver_needs_bucket;                               \
driver_prepare_bucket;                             \
driver_process_bucket;                             \
driver_write_bucket;                               \
driver_close;                                      \
static AtDriverNodeMethods ai_driver_mtds = {      \
   DriverSupportsPixelType,                        \
   DriverExtension,                                \
   DriverOpen,                                     \
   DriverNeedsBucket,                              \
   DriverPrepareBucket,                            \
   DriverProcessBucket,                            \
   DriverWriteBucket,                              \
   DriverClose,                                    \
};                                                 \
static AtNodeMethods ai_node_mtds = {              \
   &ai_common_mtds,                                \
   &ai_driver_mtds                                 \
};                                                 \
const AtNodeMethods *tag = &ai_node_mtds;
 
#define driver_supports_pixel_type \
static bool DriverSupportsPixelType(const AtNode* node, uint8_t pixel_type)
 
#define driver_extension \
static const char** DriverExtension()
 
#define driver_open \
static void DriverOpen(AtNode* node, struct AtOutputIterator* iterator, AtBBox2 display_window, AtBBox2 data_window, int bucket_size)
 
#define driver_needs_bucket \
static bool DriverNeedsBucket(AtNode* node, int bucket_xo, int bucket_yo, int bucket_size_x, int bucket_size_y, uint16_t tid)
 
#define driver_prepare_bucket \
static void DriverPrepareBucket(AtNode* node, int bucket_xo, int bucket_yo, int bucket_size_x, int bucket_size_y, uint16_t tid)
 
#define driver_process_bucket \
static void DriverProcessBucket(AtNode* node, struct AtOutputIterator* iterator, struct AtAOVSampleIterator* sample_iterator, int bucket_xo, int bucket_yo, int bucket_size_x, int bucket_size_y, uint16_t tid)
 
#define driver_write_bucket \
static void DriverWriteBucket(AtNode* node, struct AtOutputIterator* iterator, struct AtAOVSampleIterator* sample_iterator, int bucket_xo, int bucket_yo, int bucket_size_x, int bucket_size_y)
 
#define driver_close \
static void DriverClose(AtNode* node, struct AtOutputIterator* iterator)
/* \}*/
 
AI_API void         AiDriverInitialize(AtNode* node, bool supports_multiple_outputs);
AI_API void         AiRawDriverInitialize(AtNode* node, const char** required_aovs, bool requires_depth);
AI_API void         AiDriverGetMatrices(AtMatrix& world_to_camera, AtMatrix& world_to_screen);
AI_API const char** AiDriverExtension(const AtNodeEntry* node_entry);
 
AI_API bool         AiOutputIteratorGetNext(struct AtOutputIterator* iter, AtString* output_name, int* pixel_type, const void** bucket_data);
AI_API void         AiOutputIteratorReset(struct AtOutputIterator* iter);
AI_API AtNode*      AiOutputIteratorGetFilter(struct AtOutputIterator* iter);
AI_API bool         AiOutputIteratorIsHalf(struct AtOutputIterator* iter);
AI_API AtString     AiOutputIteratorGetLayerName(struct AtOutputIterator* iter);
AI_API AtNode*      AiOutputIteratorGetCamera(struct AtOutputIterator* iter);
 
AI_API const AtNodeEntry* AiFindDriverType(const char* extension);
 
/* \}*/
 
/*\}*/