RayGen.h

// ======================================================================== //
// Copyright 2019-2021 Ingo Wald                                            //
//                                                                          //
// Licensed under the Apache License, Version 2.0 (the "License");          //
// you may not use this file except in compliance with the License.         //
// You may obtain a copy of the License at                                  //
//                                                                          //
//     http://www.apache.org/licenses/LICENSE-2.0                           //
//                                                                          //
// Unless required by applicable law or agreed to in writing, software      //
// distributed under the License is distributed on an "AS IS" BASIS,        //
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. //
// See the License for the specific language governing permissions and      //
// limitations under the License.                                           //
// ======================================================================== //
 
#pragma once
 
#include "SBTObject.h"
#include "Module.h"
#include "LaunchParams.h"
 
namespace owl {
 
  struct RayGenType : public SBTObjectType {
    typedef std::shared_ptr<RayGenType> SP;
 
    struct DeviceData : public RegisteredObject::DeviceData {
      typedef std::shared_ptr<DeviceData> SP;
      
      DeviceData(const DeviceContext::SP &device);
      
      OptixProgramGroup pg = 0;
    };
    
    RayGenType(Context *const context,
               Module::SP module,
               const std::string &progName,
               size_t varStructSize,
               const std::vector<OWLVarDecl> &varDecls);
    
    std::string toString() const override;
    
    inline DeviceData &getDD(const DeviceContext::SP &device) const;
    
    RegisteredObject::DeviceData::SP createOn(const DeviceContext::SP &device) override;
 
    Module::SP        module;
    
    const std::string progName;
    const std::string annotatedProgName;
  };
  
  struct RayGen : public SBTObject<RayGenType> {
    typedef std::shared_ptr<RayGen> SP;
 
    struct DeviceData : public RegisteredObject::DeviceData {
      DeviceData(const DeviceContext::SP &device, size_t dataSize);
      
      DeviceMemory         sbtRecordBuffer;
 
      const size_t         rayGenRecordSize;
    };
 
    RayGen(Context *const context,
           RayGenType::SP type);
 
    virtual ~RayGen();
    
    std::string toString() const override;
 
    void launch(const vec3i &dims);
 
    void launchAsync(const vec3i &dims, const LaunchParams::SP &launchParams);
 
    void launchAsyncOnDevice(const vec3i &dims,
                             uint32_t deviceID,
                             const LaunchParams::SP &launchParams);
    
    void writeSBTRecord(uint8_t *const sbtRecord, const DeviceContext::SP &device);
 
    RegisteredObject::DeviceData::SP createOn(const DeviceContext::SP &device) override;
 
    inline DeviceData &getDD(const DeviceContext::SP &device) const;
  };
 
  // ------------------------------------------------------------------
  // implementation section
  // ------------------------------------------------------------------
  
  inline RayGenType::DeviceData &
  RayGenType::getDD(const DeviceContext::SP &device) const
  {
    assert(device && device->ID >= 0 && device->ID < (int)deviceData.size());
    return deviceData[device->ID]->as<RayGenType::DeviceData>();
  }
 
  inline RayGen::DeviceData &
  RayGen::getDD(const DeviceContext::SP &device) const
  {
    assert(device && device->ID >= 0 && device->ID < (int)deviceData.size());
    return deviceData[device->ID]->as<RayGen::DeviceData>();
  }
} // ::owl