From f5f6a899903a309f1fc93b31c0297fc7b3b5cf46 Mon Sep 17 00:00:00 2001 From: Andrew Reidmeyer Date: Wed, 15 Mar 2017 09:28:59 -0600 Subject: Initial 1.0.0 binary release --- docs/api/files/NVIDIA.css | 1634 ++++++++++++++++++++ docs/api/files/_nv_flow_8h-source.html | 1039 +++++++++++++ docs/api/files/_nv_flow_8h.html | 541 +++++++ docs/api/files/_nv_flow_context_8h-source.html | 96 ++ docs/api/files/_nv_flow_context_8h.html | 122 ++ .../files/_nv_flow_context_d3_d11_8h-source.html | 98 ++ docs/api/files/_nv_flow_context_d3_d11_8h.html | 73 + .../files/_nv_flow_context_d3_d12_8h-source.html | 130 ++ docs/api/files/_nv_flow_context_d3_d12_8h.html | 77 + docs/api/files/_nv_flow_shader_8h-source.html | 134 ++ docs/api/files/_nv_flow_shader_8h.html | 50 + docs/api/files/_nv_flow_types_8h-source.html | 135 ++ docs/api/files/_nv_flow_types_8h.html | 269 ++++ docs/api/files/annotated.html | 115 ++ docs/api/files/classes.html | 36 + docs/api/files/doxygen.png | Bin 0 -> 1281 bytes docs/api/files/files.html | 46 + docs/api/files/ftv2blank.png | Bin 0 -> 174 bytes docs/api/files/ftv2doc.png | Bin 0 -> 255 bytes docs/api/files/ftv2folderclosed.png | Bin 0 -> 259 bytes docs/api/files/ftv2folderopen.png | Bin 0 -> 261 bytes docs/api/files/ftv2lastnode.png | Bin 0 -> 233 bytes docs/api/files/ftv2link.png | Bin 0 -> 358 bytes docs/api/files/ftv2mlastnode.png | Bin 0 -> 160 bytes docs/api/files/ftv2mnode.png | Bin 0 -> 194 bytes docs/api/files/ftv2node.png | Bin 0 -> 235 bytes docs/api/files/ftv2plastnode.png | Bin 0 -> 165 bytes docs/api/files/ftv2pnode.png | Bin 0 -> 200 bytes docs/api/files/ftv2vertline.png | Bin 0 -> 229 bytes docs/api/files/functions.html | 90 ++ docs/api/files/functions_0x62.html | 105 ++ docs/api/files/functions_0x63.html | 123 ++ docs/api/files/functions_0x64.html | 129 ++ docs/api/files/functions_0x65.html | 77 + docs/api/files/functions_0x66.html | 91 ++ docs/api/files/functions_0x67.html | 109 ++ docs/api/files/functions_0x68.html | 79 + docs/api/files/functions_0x69.html | 91 ++ docs/api/files/functions_0x6c.html | 94 ++ docs/api/files/functions_0x6d.html | 131 ++ docs/api/files/functions_0x6e.html | 111 ++ docs/api/files/functions_0x6f.html | 72 + docs/api/files/functions_0x70.html | 100 ++ docs/api/files/functions_0x71.html | 72 + docs/api/files/functions_0x72.html | 116 ++ docs/api/files/functions_0x73.html | 149 ++ docs/api/files/functions_0x74.html | 83 + docs/api/files/functions_0x75.html | 81 + docs/api/files/functions_0x76.html | 109 ++ docs/api/files/functions_0x77.html | 84 + docs/api/files/functions_0x78.html | 78 + docs/api/files/functions_0x79.html | 78 + docs/api/files/functions_0x7a.html | 77 + docs/api/files/functions_vars.html | 90 ++ docs/api/files/functions_vars_0x62.html | 105 ++ docs/api/files/functions_vars_0x63.html | 123 ++ docs/api/files/functions_vars_0x64.html | 129 ++ docs/api/files/functions_vars_0x65.html | 77 + docs/api/files/functions_vars_0x66.html | 91 ++ docs/api/files/functions_vars_0x67.html | 109 ++ docs/api/files/functions_vars_0x68.html | 79 + docs/api/files/functions_vars_0x69.html | 91 ++ docs/api/files/functions_vars_0x6c.html | 94 ++ docs/api/files/functions_vars_0x6d.html | 131 ++ docs/api/files/functions_vars_0x6e.html | 111 ++ docs/api/files/functions_vars_0x6f.html | 72 + docs/api/files/functions_vars_0x70.html | 100 ++ docs/api/files/functions_vars_0x71.html | 72 + docs/api/files/functions_vars_0x72.html | 116 ++ docs/api/files/functions_vars_0x73.html | 149 ++ docs/api/files/functions_vars_0x74.html | 83 + docs/api/files/functions_vars_0x75.html | 81 + docs/api/files/functions_vars_0x76.html | 109 ++ docs/api/files/functions_vars_0x77.html | 84 + docs/api/files/functions_vars_0x78.html | 78 + docs/api/files/functions_vars_0x79.html | 78 + docs/api/files/functions_vars_0x7a.html | 77 + docs/api/files/globals.html | 218 +++ docs/api/files/globals_0x6e.html | 368 +++++ docs/api/files/globals_defs.html | 56 + docs/api/files/globals_enum.html | 84 + docs/api/files/globals_eval.html | 217 +++ docs/api/files/globals_func.html | 321 ++++ docs/api/files/globals_type.html | 62 + docs/api/files/group___nv_flow_context.html | 411 +++++ docs/api/files/group___nv_flow_context_d3_d11.html | 421 +++++ docs/api/files/group___nv_flow_context_d3_d12.html | 425 +++++ docs/api/files/group___nv_flow_cross_section.html | 184 +++ docs/api/files/group___nv_flow_device.html | 527 +++++++ docs/api/files/group___nv_flow_grid.html | 642 ++++++++ docs/api/files/group___nv_flow_grid_emit.html | 220 +++ .../files/group___nv_flow_grid_emit_custom.html | 225 +++ docs/api/files/group___nv_flow_grid_export.html | 226 +++ docs/api/files/group___nv_flow_grid_import.html | 516 +++++++ docs/api/files/group___nv_flow_grid_material.html | 270 ++++ docs/api/files/group___nv_flow_grid_proxy.html | 258 ++++ .../files/group___nv_flow_particle_surface.html | 409 +++++ .../api/files/group___nv_flow_render_material.html | 407 +++++ .../api/files/group___nv_flow_s_d_f_generator.html | 271 ++++ docs/api/files/group___nv_flow_shape.html | 317 ++++ docs/api/files/group___nv_flow_volume_render.html | 382 +++++ docs/api/files/group___nv_flow_volume_shadow.html | 291 ++++ docs/api/files/index.html | 11 + docs/api/files/main.html | 34 + docs/api/files/modules.html | 52 + docs/api/files/nvflow_logo.png | Bin 0 -> 3560 bytes docs/api/files/struct_nv_flow_color_map_data.html | 85 + .../files/struct_nv_flow_context_desc_d3_d11.html | 78 + .../files/struct_nv_flow_context_desc_d3_d12.html | 184 +++ .../files/struct_nv_flow_cross_section_desc.html | 68 + .../files/struct_nv_flow_cross_section_params.html | 488 ++++++ ...uct_nv_flow_depth_stencil_view_desc_d3_d11.html | 95 ++ ...uct_nv_flow_depth_stencil_view_desc_d3_d12.html | 163 ++ ...t_nv_flow_descriptor_reserve_handle_d3_d12.html | 112 ++ docs/api/files/struct_nv_flow_device_desc.html | 108 ++ .../files/struct_nv_flow_device_queue_desc.html | 82 + .../files/struct_nv_flow_device_queue_status.html | 108 ++ docs/api/files/struct_nv_flow_dim.html | 92 ++ ...uct_nv_flow_dynamic_descriptor_heap_d3_d12.html | 78 + docs/api/files/struct_nv_flow_float3.html | 92 ++ docs/api/files/struct_nv_flow_float4.html | 109 ++ docs/api/files/struct_nv_flow_float4x4.html | 109 ++ docs/api/files/struct_nv_flow_grid_desc.html | 208 +++ ...ruct_nv_flow_grid_emit_custom_alloc_params.html | 148 ++ ...nv_flow_grid_emit_custom_emit_layer_params.html | 228 +++ ...truct_nv_flow_grid_emit_custom_emit_params.html | 108 ++ .../api/files/struct_nv_flow_grid_emit_params.html | 688 +++++++++ .../struct_nv_flow_grid_export_debug_vis_view.html | 228 +++ .../files/struct_nv_flow_grid_export_handle.html | 108 ++ ...t_nv_flow_grid_export_import_layer_mapping.html | 128 ++ ...nv_flow_grid_export_import_layered_mapping.html | 148 ++ .../struct_nv_flow_grid_export_layer_view.html | 88 ++ .../struct_nv_flow_grid_export_layered_view.html | 68 + .../struct_nv_flow_grid_export_simple_shape.html | 88 ++ .../api/files/struct_nv_flow_grid_import_desc.html | 68 + .../files/struct_nv_flow_grid_import_handle.html | 108 ++ .../struct_nv_flow_grid_import_layer_view.html | 128 ++ .../struct_nv_flow_grid_import_layered_view.html | 68 + .../files/struct_nv_flow_grid_import_params.html | 108 ++ ...uct_nv_flow_grid_import_state_c_p_u_params.html | 108 ++ .../files/struct_nv_flow_grid_material_handle.html | 88 ++ .../files/struct_nv_flow_grid_material_params.html | 328 ++++ ...struct_nv_flow_grid_material_per_component.html | 168 ++ docs/api/files/struct_nv_flow_grid_params.html | 148 ++ docs/api/files/struct_nv_flow_grid_proxy_desc.html | 168 ++ .../struct_nv_flow_grid_proxy_flush_params.html | 108 ++ docs/api/files/struct_nv_flow_grid_reset_desc.html | 88 ++ .../struct_nv_flow_particle_surface_data.html | 108 ++ .../struct_nv_flow_particle_surface_desc.html | 148 ++ ...truct_nv_flow_particle_surface_emit_params.html | 225 +++ .../struct_nv_flow_particle_surface_params.html | 108 ++ docs/api/files/struct_nv_flow_query_time.html | 65 + .../struct_nv_flow_render_material_handle.html | 88 ++ .../struct_nv_flow_render_material_params.html | 248 +++ .../struct_nv_flow_render_material_pool_desc.html | 68 + ...uct_nv_flow_render_target_view_desc_d3_d11.html | 78 + ...uct_nv_flow_render_target_view_desc_d3_d12.html | 146 ++ ...ruct_nv_flow_resource_r_w_view_desc_d3_d11.html | 78 + ...ruct_nv_flow_resource_r_w_view_desc_d3_d12.html | 95 ++ .../struct_nv_flow_resource_view_desc_d3_d11.html | 61 + .../struct_nv_flow_resource_view_desc_d3_d12.html | 112 ++ docs/api/files/struct_nv_flow_s_d_f_gen_desc.html | 68 + .../struct_nv_flow_s_d_f_gen_mesh_params.html | 248 +++ .../files/struct_nv_flow_shader_linear_params.html | 235 +++ .../files/struct_nv_flow_shader_point_params.html | 133 ++ docs/api/files/struct_nv_flow_shape_desc_box.html | 68 + .../files/struct_nv_flow_shape_desc_capsule.html | 88 ++ .../api/files/struct_nv_flow_shape_desc_plane.html | 88 ++ .../api/files/struct_nv_flow_shape_desc_s_d_f.html | 68 + .../files/struct_nv_flow_shape_desc_sphere.html | 68 + .../api/files/struct_nv_flow_shape_s_d_f_data.html | 128 ++ .../api/files/struct_nv_flow_shape_s_d_f_desc.html | 68 + docs/api/files/struct_nv_flow_support.html | 68 + docs/api/files/struct_nv_flow_uint2.html | 75 + docs/api/files/struct_nv_flow_uint3.html | 92 ++ docs/api/files/struct_nv_flow_uint4.html | 109 ++ .../struct_nv_flow_volume_lighting_params.html | 108 ++ .../files/struct_nv_flow_volume_render_desc.html | 68 + .../struct_nv_flow_volume_render_l_m_s_params.html | 264 ++++ ...uct_nv_flow_volume_render_multi_res_params.html | 248 +++ .../files/struct_nv_flow_volume_render_params.html | 488 ++++++ .../struct_nv_flow_volume_render_viewport.html | 116 ++ ..._nv_flow_volume_shadow_debug_render_params.html | 108 ++ .../files/struct_nv_flow_volume_shadow_desc.html | 168 ++ .../files/struct_nv_flow_volume_shadow_params.html | 228 +++ .../files/struct_nv_flow_volume_shadow_stats.html | 99 ++ docs/api/files/tab_b.gif | Bin 0 -> 35 bytes docs/api/files/tab_l.gif | Bin 0 -> 706 bytes docs/api/files/tab_r.gif | Bin 0 -> 2585 bytes docs/api/files/tabs.css | 105 ++ docs/api/files/tree.html | 579 +++++++ docs/api/files/union_nv_flow_shape_desc.html | 133 ++ docs/api/index.html | 4 + 193 files changed, 28997 insertions(+) create mode 100644 docs/api/files/NVIDIA.css create mode 100644 docs/api/files/_nv_flow_8h-source.html create mode 100644 docs/api/files/_nv_flow_8h.html create mode 100644 docs/api/files/_nv_flow_context_8h-source.html create mode 100644 docs/api/files/_nv_flow_context_8h.html create mode 100644 docs/api/files/_nv_flow_context_d3_d11_8h-source.html create mode 100644 docs/api/files/_nv_flow_context_d3_d11_8h.html create mode 100644 docs/api/files/_nv_flow_context_d3_d12_8h-source.html create mode 100644 docs/api/files/_nv_flow_context_d3_d12_8h.html create mode 100644 docs/api/files/_nv_flow_shader_8h-source.html create mode 100644 docs/api/files/_nv_flow_shader_8h.html create mode 100644 docs/api/files/_nv_flow_types_8h-source.html create mode 100644 docs/api/files/_nv_flow_types_8h.html create mode 100644 docs/api/files/annotated.html create mode 100644 docs/api/files/classes.html create mode 100644 docs/api/files/doxygen.png create mode 100644 docs/api/files/files.html create mode 100644 docs/api/files/ftv2blank.png create mode 100644 docs/api/files/ftv2doc.png create mode 100644 docs/api/files/ftv2folderclosed.png create mode 100644 docs/api/files/ftv2folderopen.png create mode 100644 docs/api/files/ftv2lastnode.png create mode 100644 docs/api/files/ftv2link.png create mode 100644 docs/api/files/ftv2mlastnode.png create mode 100644 docs/api/files/ftv2mnode.png create mode 100644 docs/api/files/ftv2node.png create mode 100644 docs/api/files/ftv2plastnode.png create mode 100644 docs/api/files/ftv2pnode.png create mode 100644 docs/api/files/ftv2vertline.png create mode 100644 docs/api/files/functions.html create mode 100644 docs/api/files/functions_0x62.html create mode 100644 docs/api/files/functions_0x63.html create mode 100644 docs/api/files/functions_0x64.html create mode 100644 docs/api/files/functions_0x65.html create mode 100644 docs/api/files/functions_0x66.html create mode 100644 docs/api/files/functions_0x67.html create mode 100644 docs/api/files/functions_0x68.html create mode 100644 docs/api/files/functions_0x69.html create mode 100644 docs/api/files/functions_0x6c.html create mode 100644 docs/api/files/functions_0x6d.html create mode 100644 docs/api/files/functions_0x6e.html create mode 100644 docs/api/files/functions_0x6f.html create mode 100644 docs/api/files/functions_0x70.html create mode 100644 docs/api/files/functions_0x71.html create mode 100644 docs/api/files/functions_0x72.html create mode 100644 docs/api/files/functions_0x73.html create mode 100644 docs/api/files/functions_0x74.html create mode 100644 docs/api/files/functions_0x75.html create mode 100644 docs/api/files/functions_0x76.html create mode 100644 docs/api/files/functions_0x77.html create mode 100644 docs/api/files/functions_0x78.html create mode 100644 docs/api/files/functions_0x79.html create mode 100644 docs/api/files/functions_0x7a.html create mode 100644 docs/api/files/functions_vars.html create mode 100644 docs/api/files/functions_vars_0x62.html create mode 100644 docs/api/files/functions_vars_0x63.html create mode 100644 docs/api/files/functions_vars_0x64.html create mode 100644 docs/api/files/functions_vars_0x65.html create mode 100644 docs/api/files/functions_vars_0x66.html create mode 100644 docs/api/files/functions_vars_0x67.html create mode 100644 docs/api/files/functions_vars_0x68.html create mode 100644 docs/api/files/functions_vars_0x69.html create mode 100644 docs/api/files/functions_vars_0x6c.html create mode 100644 docs/api/files/functions_vars_0x6d.html create mode 100644 docs/api/files/functions_vars_0x6e.html create mode 100644 docs/api/files/functions_vars_0x6f.html create mode 100644 docs/api/files/functions_vars_0x70.html create mode 100644 docs/api/files/functions_vars_0x71.html create mode 100644 docs/api/files/functions_vars_0x72.html create mode 100644 docs/api/files/functions_vars_0x73.html create mode 100644 docs/api/files/functions_vars_0x74.html create mode 100644 docs/api/files/functions_vars_0x75.html create mode 100644 docs/api/files/functions_vars_0x76.html create mode 100644 docs/api/files/functions_vars_0x77.html create mode 100644 docs/api/files/functions_vars_0x78.html create mode 100644 docs/api/files/functions_vars_0x79.html create mode 100644 docs/api/files/functions_vars_0x7a.html create mode 100644 docs/api/files/globals.html create mode 100644 docs/api/files/globals_0x6e.html create mode 100644 docs/api/files/globals_defs.html create mode 100644 docs/api/files/globals_enum.html create mode 100644 docs/api/files/globals_eval.html create mode 100644 docs/api/files/globals_func.html create mode 100644 docs/api/files/globals_type.html create mode 100644 docs/api/files/group___nv_flow_context.html create mode 100644 docs/api/files/group___nv_flow_context_d3_d11.html create mode 100644 docs/api/files/group___nv_flow_context_d3_d12.html create mode 100644 docs/api/files/group___nv_flow_cross_section.html create mode 100644 docs/api/files/group___nv_flow_device.html create mode 100644 docs/api/files/group___nv_flow_grid.html create mode 100644 docs/api/files/group___nv_flow_grid_emit.html create mode 100644 docs/api/files/group___nv_flow_grid_emit_custom.html create mode 100644 docs/api/files/group___nv_flow_grid_export.html create mode 100644 docs/api/files/group___nv_flow_grid_import.html create mode 100644 docs/api/files/group___nv_flow_grid_material.html create mode 100644 docs/api/files/group___nv_flow_grid_proxy.html create mode 100644 docs/api/files/group___nv_flow_particle_surface.html create mode 100644 docs/api/files/group___nv_flow_render_material.html create mode 100644 docs/api/files/group___nv_flow_s_d_f_generator.html create mode 100644 docs/api/files/group___nv_flow_shape.html create mode 100644 docs/api/files/group___nv_flow_volume_render.html create mode 100644 docs/api/files/group___nv_flow_volume_shadow.html create mode 100644 docs/api/files/index.html create mode 100644 docs/api/files/main.html create mode 100644 docs/api/files/modules.html create mode 100644 docs/api/files/nvflow_logo.png create mode 100644 docs/api/files/struct_nv_flow_color_map_data.html create mode 100644 docs/api/files/struct_nv_flow_context_desc_d3_d11.html create mode 100644 docs/api/files/struct_nv_flow_context_desc_d3_d12.html create mode 100644 docs/api/files/struct_nv_flow_cross_section_desc.html create mode 100644 docs/api/files/struct_nv_flow_cross_section_params.html create mode 100644 docs/api/files/struct_nv_flow_depth_stencil_view_desc_d3_d11.html create mode 100644 docs/api/files/struct_nv_flow_depth_stencil_view_desc_d3_d12.html create mode 100644 docs/api/files/struct_nv_flow_descriptor_reserve_handle_d3_d12.html create mode 100644 docs/api/files/struct_nv_flow_device_desc.html create mode 100644 docs/api/files/struct_nv_flow_device_queue_desc.html create mode 100644 docs/api/files/struct_nv_flow_device_queue_status.html create mode 100644 docs/api/files/struct_nv_flow_dim.html create mode 100644 docs/api/files/struct_nv_flow_dynamic_descriptor_heap_d3_d12.html create mode 100644 docs/api/files/struct_nv_flow_float3.html create mode 100644 docs/api/files/struct_nv_flow_float4.html create mode 100644 docs/api/files/struct_nv_flow_float4x4.html create mode 100644 docs/api/files/struct_nv_flow_grid_desc.html create mode 100644 docs/api/files/struct_nv_flow_grid_emit_custom_alloc_params.html create mode 100644 docs/api/files/struct_nv_flow_grid_emit_custom_emit_layer_params.html create mode 100644 docs/api/files/struct_nv_flow_grid_emit_custom_emit_params.html create mode 100644 docs/api/files/struct_nv_flow_grid_emit_params.html create mode 100644 docs/api/files/struct_nv_flow_grid_export_debug_vis_view.html create mode 100644 docs/api/files/struct_nv_flow_grid_export_handle.html create mode 100644 docs/api/files/struct_nv_flow_grid_export_import_layer_mapping.html create mode 100644 docs/api/files/struct_nv_flow_grid_export_import_layered_mapping.html create mode 100644 docs/api/files/struct_nv_flow_grid_export_layer_view.html create mode 100644 docs/api/files/struct_nv_flow_grid_export_layered_view.html create mode 100644 docs/api/files/struct_nv_flow_grid_export_simple_shape.html create mode 100644 docs/api/files/struct_nv_flow_grid_import_desc.html create mode 100644 docs/api/files/struct_nv_flow_grid_import_handle.html create mode 100644 docs/api/files/struct_nv_flow_grid_import_layer_view.html create mode 100644 docs/api/files/struct_nv_flow_grid_import_layered_view.html create mode 100644 docs/api/files/struct_nv_flow_grid_import_params.html create mode 100644 docs/api/files/struct_nv_flow_grid_import_state_c_p_u_params.html create mode 100644 docs/api/files/struct_nv_flow_grid_material_handle.html create mode 100644 docs/api/files/struct_nv_flow_grid_material_params.html create mode 100644 docs/api/files/struct_nv_flow_grid_material_per_component.html create mode 100644 docs/api/files/struct_nv_flow_grid_params.html create mode 100644 docs/api/files/struct_nv_flow_grid_proxy_desc.html create mode 100644 docs/api/files/struct_nv_flow_grid_proxy_flush_params.html create mode 100644 docs/api/files/struct_nv_flow_grid_reset_desc.html create mode 100644 docs/api/files/struct_nv_flow_particle_surface_data.html create mode 100644 docs/api/files/struct_nv_flow_particle_surface_desc.html create mode 100644 docs/api/files/struct_nv_flow_particle_surface_emit_params.html create mode 100644 docs/api/files/struct_nv_flow_particle_surface_params.html create mode 100644 docs/api/files/struct_nv_flow_query_time.html create mode 100644 docs/api/files/struct_nv_flow_render_material_handle.html create mode 100644 docs/api/files/struct_nv_flow_render_material_params.html create mode 100644 docs/api/files/struct_nv_flow_render_material_pool_desc.html create mode 100644 docs/api/files/struct_nv_flow_render_target_view_desc_d3_d11.html create mode 100644 docs/api/files/struct_nv_flow_render_target_view_desc_d3_d12.html create mode 100644 docs/api/files/struct_nv_flow_resource_r_w_view_desc_d3_d11.html create mode 100644 docs/api/files/struct_nv_flow_resource_r_w_view_desc_d3_d12.html create mode 100644 docs/api/files/struct_nv_flow_resource_view_desc_d3_d11.html create mode 100644 docs/api/files/struct_nv_flow_resource_view_desc_d3_d12.html create mode 100644 docs/api/files/struct_nv_flow_s_d_f_gen_desc.html create mode 100644 docs/api/files/struct_nv_flow_s_d_f_gen_mesh_params.html create mode 100644 docs/api/files/struct_nv_flow_shader_linear_params.html create mode 100644 docs/api/files/struct_nv_flow_shader_point_params.html create mode 100644 docs/api/files/struct_nv_flow_shape_desc_box.html create mode 100644 docs/api/files/struct_nv_flow_shape_desc_capsule.html create mode 100644 docs/api/files/struct_nv_flow_shape_desc_plane.html create mode 100644 docs/api/files/struct_nv_flow_shape_desc_s_d_f.html create mode 100644 docs/api/files/struct_nv_flow_shape_desc_sphere.html create mode 100644 docs/api/files/struct_nv_flow_shape_s_d_f_data.html create mode 100644 docs/api/files/struct_nv_flow_shape_s_d_f_desc.html create mode 100644 docs/api/files/struct_nv_flow_support.html create mode 100644 docs/api/files/struct_nv_flow_uint2.html create mode 100644 docs/api/files/struct_nv_flow_uint3.html create mode 100644 docs/api/files/struct_nv_flow_uint4.html create mode 100644 docs/api/files/struct_nv_flow_volume_lighting_params.html create mode 100644 docs/api/files/struct_nv_flow_volume_render_desc.html create mode 100644 docs/api/files/struct_nv_flow_volume_render_l_m_s_params.html create mode 100644 docs/api/files/struct_nv_flow_volume_render_multi_res_params.html create mode 100644 docs/api/files/struct_nv_flow_volume_render_params.html create mode 100644 docs/api/files/struct_nv_flow_volume_render_viewport.html create mode 100644 docs/api/files/struct_nv_flow_volume_shadow_debug_render_params.html create mode 100644 docs/api/files/struct_nv_flow_volume_shadow_desc.html create mode 100644 docs/api/files/struct_nv_flow_volume_shadow_params.html create mode 100644 docs/api/files/struct_nv_flow_volume_shadow_stats.html create mode 100644 docs/api/files/tab_b.gif create mode 100644 docs/api/files/tab_l.gif create mode 100644 docs/api/files/tab_r.gif create mode 100644 docs/api/files/tabs.css create mode 100644 docs/api/files/tree.html create mode 100644 docs/api/files/union_nv_flow_shape_desc.html create mode 100644 docs/api/index.html (limited to 'docs/api') diff --git a/docs/api/files/NVIDIA.css b/docs/api/files/NVIDIA.css new file mode 100644 index 0000000..c5bb745 --- /dev/null +++ b/docs/api/files/NVIDIA.css @@ -0,0 +1,1634 @@ +/* The standard CSS for doxygen $doxygenversion */ + +body, table, div, p, dl { + font: 400 14px/22px Roboto,sans-serif; +} + +/* @group Heading Levels */ + +h1.groupheader { + font-size: 150%; +} + +.title { + font: 400 14px/28px Roboto,sans-serif; + font-size: 150%; + font-weight: bold; + margin: 10px 2px; +} + +h2.groupheader { + border-bottom: 1px solid ##99; + color: ##44; + font-size: 150%; + font-weight: normal; + margin-top: 1.75em; + padding-top: 8px; + padding-bottom: 4px; + width: 100%; +} + +h3.groupheader { + font-size: 100%; +} + +h1, h2, h3, h4, h5, h6 { + -webkit-transition: text-shadow 0.5s linear; + -moz-transition: text-shadow 0.5s linear; + -ms-transition: text-shadow 0.5s linear; + -o-transition: text-shadow 0.5s linear; + transition: text-shadow 0.5s linear; + margin-right: 15px; +} + +h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { + text-shadow: 0 0 15px cyan; +} + +dt { + font-weight: bold; +} + +div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; +} + +p.startli, p.startdd { + margin-top: 2px; +} + +p.starttd { + margin-top: 0px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.qindex, div.navtab{ + background-color: #e0f0e1; + background-image: linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -ms-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -o-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -webkit-gradient(linear, left top, left bottom, from(#e0f0e1), to(#d0e0d1)); + background-image: -moz-linear-gradient(top, #e0f0e1, #d0e0d1); + border: 1px solid #cceecc; + text-align: center; + margin: 2px; + padding: 2px; +} + +div.footer { + text-align: center; + margin: 12px; + /* color: #216414; */ +} + +div.qindex, div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ + +a { + color: #216414; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #28a028; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: ##AA; + color: #ffffff; + border: 1px double ##98; +} + +.contents a.qindexHL:visited { + color: #ffffff; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code, a.code:visited, a.line, a.line:visited { + color: #4665A2; +} + +a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited { + color: #4665A2; +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +pre.fragment { + border: 1px solid #cceecc; + background-color: #e0f0e1; + background-image: linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -ms-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -o-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -webkit-gradient(linear, left top, left bottom, from(#e0f0e1), to(#d0e0d1)); + background-image: -moz-linear-gradient(top, #e0f0e1, #d0e0d1); + + border: 1px solid #C4CFE5; + background-color: #FBFCFD; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; + font-family: monospace, fixed; + font-size: 105%; +} + +div.fragment { + padding: 0px; + margin: 4px 8px 4px 2px; + background-color: ##FC; + border: 1px solid ##CC; +} + +div.line { + font-family: monospace, fixed; + font-size: 13px; + min-height: 13px; + line-height: 1.0; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + text-indent: -53px; + padding-left: 53px; + padding-bottom: 0px; + margin: 0px; + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +div.line:after { + content:"\000A"; + white-space: pre; +} + +div.line.glow { + background-color: cyan; + box-shadow: 0 0 10px cyan; +} + + +span.lineno { + padding-right: 4px; + text-align: right; + border-right: 2px solid #0F0; + background-color: #E8E8E8; + white-space: pre; +} +span.lineno a { + background-color: #D8D8D8; +} + +span.lineno a:hover { + background-color: #C8C8C8; +} + +div.ah, span.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; + box-shadow: 2px 2px 3px #999; + -webkit-box-shadow: 2px 2px 3px #999; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); + background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000 110%); +} + +div.classindex ul { + list-style: none; + padding-left: 0; +} + +div.classindex span.ai { + display: inline-block; +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background-color: white; + color: black; + margin: 0; +} + +div.contents { + margin-top: 10px; + margin-left: 12px; + margin-right: 8px; +} + +td.indexkey { + background-color: #e0f0e1; + background-image: linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -ms-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -o-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -webkit-gradient(linear, left top, left bottom, from(#e0f0e1), to(#d0e0d1)); + background-image: -moz-linear-gradient(top, #e0f0e1, #d0e0d1); + + border: 0px solid #ffffff; + + font-weight: bold; + margin: 2px 0px 2px 0; + padding: 2px 10px; + white-space: nowrap; + vertical-align: top; +} + +td.indexvalue { + background-color: #e0f0e1; + background-image: linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -ms-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -o-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -webkit-gradient(linear, left top, left bottom, from(#e0f0e1), to(#d0e0d1)); + background-image: -moz-linear-gradient(top, #e0f0e1, #d0e0d1); + border: 0px solid #ffffff; + + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #e0f0e1; + background-image: linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -ms-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -o-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -webkit-gradient(linear, left top, left bottom, from(#e0f0e1), to(#d0e0d1)); + background-image: -moz-linear-gradient(top, #e0f0e1, #d0e0d1); +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +address.footer { + text-align: right; + padding-right: 12px; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #002090 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +blockquote { + background-color: ##F8; + border-left: 2px solid ##AA; + margin: 0 24px 0 4px; + padding: 0 12px 0 16px; +} + +/* @end */ + +/* +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +*/ + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e0f0e1; + background-image: linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -ms-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -o-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -webkit-gradient(linear, left top, left bottom, from(#e0f0e1), to(#d0e0d1)); + background-image: -moz-linear-gradient(top, #e0f0e1, #d0e0d1); +} + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #cceecc; +} + +th.dirtab { + background-color: #e0f0e1; + background-image: linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -ms-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -o-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -webkit-gradient(linear, left top, left bottom, from(#e0f0e1), to(#d0e0d1)); + background-image: -moz-linear-gradient(top, #e0f0e1, #d0e0d1); + font-weight: bold; +} + +hr { + color: FFFFFF; + height: 16; + border: none; + border-top: 1px solid ##66; +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ + +table.memberdecls { + border-spacing: 0px; + padding: 0px; +} + +.memberdecls td, .fieldtable tr { + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +.memberdecls td.glow, .fieldtable tr.glow { + background-color: cyan; + box-shadow: 0 0 15px cyan; +} + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #d0e0d1; + margin: 8px; + padding: 6px 0 0 8px; + box-shadow: 2px 2px 4px 0px #666; + -moz-box-shadow: 4px 4px 2px 1px #aaa; + -webkit-box-shadow: 2px 2px 4px 0px #666; +} + +.mdescLeft, .mdescRight { + padding: 6px 8px 8px 8px; + color: #555; +} + +.memSeparator { + border-bottom: 1px solid #DEE4F0; + line-height: 1px; + margin: 0px; + padding: 0px; +} + +.memItemLeft, .memTemplItemLeft, .memTemplParams { + background-color: #e0f0e1; + background-image: linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -ms-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -o-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -webkit-gradient(linear, left top, left bottom, from(#e0f0e1), to(#d0e0d1)); + background-image: -moz-linear-gradient(top, #e0f0e1, #d0e0d1); + border-top: 1px solid #b0d1b1; + + white-space: nowrap; +} + +.memItemRight { + width: 100%; +} + +.memTemplParams { + color: #606060; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtemplate { + font-size: 80%; + color: ##60; + font-weight: normal; + margin-left: 9px; +} + +.memnav { + background-color: #e0f0e1; + background-image: linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -ms-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -o-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -webkit-gradient(linear, left top, left bottom, from(#e0f0e1), to(#d0e0d1)); + background-image: -moz-linear-gradient(top, #e0f0e1, #d0e0d1); + border: 1px solid #cceecc; + + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.mempage { + width: 100%; +} + +.memitem { + -webkit-border-top-left-radius: 8px; + -webkit-border-top-right-radius: 8px; + -moz-border-radius-topleft: 8px; + -moz-border-radius-topright: 8px; + -webkit-border-bottom-left-radius: 8px; + -webkit-border-bottom-right-radius: 8px; + -moz-border-radius-bottomleft: 8px; + -moz-border-radius-bottomright: 8px; + border: 1px solid #b0c0b1; + + padding: 0; + + /* margin: 14px 0px 0px 0px; + box-shadow: 2px 2px 4px 1px #666; + -moz-box-shadow: 2px 2px 4px 1px #666; + -webkit-box-shadow: 2px 2px 4px 1px #666; */ + + margin-bottom: 10px; + margin-right: 5px; + -webkit-transition: box-shadow 0.5s linear; + -moz-transition: box-shadow 0.5s linear; + -ms-transition: box-shadow 0.5s linear; + -o-transition: box-shadow 0.5s linear; + transition: box-shadow 0.5s linear; + display: table !important; + width: 100%; +} + +.memitem.glow { + box-shadow: 0 0 15px cyan; +} + +.memname { + font-weight: bold; + margin-left: 6px; +} + +.memname td { + vertical-align: bottom; +} + +.memproto, dl.reflist dt { + background-color: #b0c0b1; + background-image: linear-gradient(top, #d0e0d1 0%, #b0c0b1 100%); + background-image: -ms-linear-gradient(top, #d0e0d1 0%, #b0c0b1 100%); + background-image: -o-linear-gradient(top, #d0e0d1 0%, #b0c0b1 100%); + background-image: -webkit-gradient(linear, left top, left bottom, from(#d0e0d1), to(#b0c0b1)); + background-image: -moz-linear-gradient(top, #e0f0e1, #b0c0b1); + + border-top: 1px solid #b0c0b1; + border-left: 1px solid #b0c0b1; + border-right: 1px solid #b0c0b1; + padding: 6px 0px 6px 0px; + color: ##2b; + font-weight: bold; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + /* opera specific markup */ + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + border-top-right-radius: 4px; + border-top-left-radius: 4px; + /* firefox specific markup */ + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 4px; + -moz-border-radius-topleft: 4px; + /* webkit specific markup */ + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 4px; + -webkit-border-top-left-radius: 4px; + +} + +.memdoc, dl.reflist dd { + background-color: #e0f0e1; + background-image: linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -ms-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -o-linear-gradient(top, #e0f0e1 0%, #d0e0d1 100%); + background-image: -webkit-gradient(linear, left top, left bottom, from(#e0f0e1), to(#d0e0d1)); + background-image: -moz-linear-gradient(top, #e0f0e1, #d0e0d1); + + border-bottom: 1px solid #b0c0b1; + border-left: 1px solid ##b0c0b1; + border-right: 1px solid #b0c0b1; + padding: 6px 10px 2px 10px; + border-top-width: 0; + background-repeat:repeat-x; + /* opera specific markup */ + border-bottom-left-radius: 4px; + border-bottom-right-radius: 4px; + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + /* firefox specific markup */ + -moz-border-radius-bottomleft: 4px; + -moz-border-radius-bottomright: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +dl.reflist dt { + padding: 5px; +} + +dl.reflist dd { + margin: 0px 0px 10px 0px; + padding: 5px; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #B06000; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} +.paramname code { + line-height: 14px; +} + +.params, .retval, .exception, .tparams { + margin-left: 0px; + padding-left: 0px; +} + +.params .paramname, .retval .paramname { + font-weight: bold; + vertical-align: top; +} + +.params .paramtype { + font-style: italic; + vertical-align: top; +} + +.params .paramdir { + font-family: "courier new",courier,monospace; + vertical-align: top; +} + +table.mlabels { + border-spacing: 0px; +} + +td.mlabels-left { + width: 100%; + padding: 0px; +} + +td.mlabels-right { + vertical-align: bottom; + padding: 0px; + white-space: nowrap; +} + +span.mlabels { + margin-left: 8px; +} + +span.mlabel { + background-color: ##88; + border-top:1px solid ##70; + border-left:1px solid ##70; + border-right:1px solid ##CC; + border-bottom:1px solid ##CC; + text-shadow: none; + color: white; + margin-right: 4px; + padding: 2px 3px; + border-radius: 3px; + font-size: 7pt; + white-space: nowrap; + vertical-align: middle; +} + + + +/* @end */ + +/* these are for tree view inside a (index) page */ + +div.directory { + margin: 10px 0px; + border-top: 1px solid ##AA; + border-bottom: 1px solid ##AA; + width: 100%; +} + +.directory table { + border-collapse:collapse; +} + +.directory td { + margin: 0px; + padding: 0px; + vertical-align: top; +} + +.directory td.entry { + white-space: nowrap; + padding-right: 6px; + padding-top: 3px; +} + +.directory td.entry a { + outline:none; +} + +.directory td.entry a img { + border: none; +} + +.directory td.desc { + width: 100%; + padding-left: 6px; + padding-right: 6px; + padding-top: 3px; + border-left: 1px solid rgba(0,0,0,0.05); +} + +.directory tr.even { + padding-left: 6px; + background-color: ##F8; +} + +.directory img { + vertical-align: -30%; +} + +.directory .levels { + white-space: nowrap; + width: 100%; + text-align: right; + font-size: 9pt; +} + +.directory .levels span { + cursor: pointer; + padding-left: 2px; + padding-right: 2px; + color: ##50; +} + +.arrow { + color: ##AA; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + font-size: 80%; + display: inline-block; + width: 16px; + height: 22px; +} + +.icon { + font-family: Arial, Helvetica; + font-weight: bold; + font-size: 12px; + height: 14px; + width: 16px; + display: inline-block; + background-color: ##88; + color: white; + text-align: center; + border-radius: 4px; + margin-left: 2px; + margin-right: 2px; +} + +.icona { + width: 24px; + height: 22px; + display: inline-block; +} + +.iconfopen { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('folderopen.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.iconfclosed { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('folderclosed.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.icondoc { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('doc.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +table.directory { + font: 400 14px Roboto,sans-serif; +} + +/* @end */ + +div.dynheader { + margin-top: 8px; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +address { + font-style: normal; + color: ##33; +} + +table.doxtable caption { + caption-side: top; +} + +table.doxtable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.doxtable td, table.doxtable th { + border: 1px solid ##37; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: ##47; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +table.fieldtable { + /*width: 100%;*/ + margin-bottom: 10px; + border: 1px solid ##B4; + border-spacing: 0px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + border-radius: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); + box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); +} + +.fieldtable td, .fieldtable th { + padding: 3px 7px 2px; +} + +.fieldtable td.fieldtype, .fieldtable td.fieldname { + white-space: nowrap; + border-right: 1px solid ##B4; + border-bottom: 1px solid ##B4; + vertical-align: top; +} + +.fieldtable td.fieldname { + padding-top: 3px; +} + +.fieldtable td.fielddoc { + border-bottom: 1px solid ##B4; + /*width: 100%;*/ +} + +.fieldtable td.fielddoc p:first-child { + margin-top: 0px; +} + +.fieldtable td.fielddoc p:last-child { + margin-bottom: 2px; +} + +.fieldtable tr:last-child td { + border-bottom: none; +} + +.fieldtable th { + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: ##E6; + font-size: 90%; + color: ##2B; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; + -moz-border-radius-topleft: 4px; + -moz-border-radius-topright: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + border-top-left-radius: 4px; + border-top-right-radius: 4px; + border-bottom: 1px solid ##B4; +} + + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + background-image:url('tab_b.png'); + background-repeat:repeat-x; + background-position: 0 -5px; + height:30px; + line-height:30px; + color:##9b; + border:solid 1px ##ca; + overflow:hidden; + margin:0px; + padding:0px; +} + +.navpath li +{ + list-style-type:none; + float:left; + padding-left:10px; + padding-right:15px; + background-image:url('bc_s.png'); + background-repeat:no-repeat; + background-position:right; + color:##45; +} + +.navpath li.navelem a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; + color: ##30; + font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + text-decoration: none; +} + +.navpath li.navelem a:hover +{ + color:##80; +} + +.navpath li.footer +{ + list-style-type:none; + float:right; + padding-left:10px; + padding-right:15px; + background-image:none; + background-repeat:no-repeat; + background-position:right; + color:##45; + font-size: 8pt; +} + + +div.summary +{ + /* float: right; */ + font-size: 9pt; + /* padding-right: 5px; */ + /* width: 50%; */ + /* text-align: right; */ + text-align: center; +} + +div.summary a +{ + white-space: nowrap; +} + +table.classindex +{ + margin: 10px; + white-space: nowrap; + margin-left: 3%; + margin-right: 3%; + width: 94%; + border: 0; + border-spacing: 0; + padding: 0; +} + +div.ingroups +{ + font-size: 8pt; + width: 50%; + text-align: left; +} + +div.ingroups a +{ + white-space: nowrap; +} + +div.header +{ + background-image:url('nav_h.png'); + background-repeat:repeat-x; + background-color: ##FA; + margin: 0px; + border-bottom: 1px solid ##CC; +} + +div.headertitle +{ + padding: 5px 5px 5px 10px; +} + +dl +{ + padding: 0 0 0 10px; +} + +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */ +dl.section +{ + margin-left: 0px; + padding-left: 0px; +} + +dl.note +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #D0C000; +} + +dl.warning, dl.attention +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #FF0000; +} + +dl.pre, dl.post, dl.invariant +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #00D000; +} + +dl.deprecated +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #505050; +} + +dl.todo +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #00C0E0; +} + +dl.test +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #3030E0; +} + +dl.bug +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #C08050; +} + +dl.section dd { + margin-bottom: 6px; +} + + +#projectlogo +{ + text-align: center; + vertical-align: bottom; + border-collapse: separate; +} + +#projectlogo img +{ + border: 0px none; +} + +#projectalign +{ + vertical-align: middle; +} + +#projectname +{ + font: 300% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 2px 0px; +} + +#projectbrief +{ + font: 120% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#projectnumber +{ + font: 50% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#titlearea +{ + padding: 0px; + margin: 0px; + width: 100%; + border-bottom: 1px solid ##70; +} + +.image +{ + text-align: center; +} + +.dotgraph +{ + text-align: center; +} + +.mscgraph +{ + text-align: center; +} + +.diagraph +{ + text-align: center; +} + +.caption +{ + font-weight: bold; +} + +div.zoom +{ + border: 1px solid ##A0; +} + +dl.citelist { + margin-bottom:50px; +} + +dl.citelist dt { + color:##40; + float:left; + font-weight:bold; + margin-right:10px; + padding:5px; +} + +dl.citelist dd { + margin:2px 0; + padding:5px 0; +} + +div.toc { + padding: 14px 25px; + background-color: ##F6; + border: 1px solid ##DD; + border-radius: 7px 7px 7px 7px; + float: right; + height: auto; + margin: 0 8px 10px 10px; + width: 200px; +} + +div.toc li { + background: url("bdwn.png") no-repeat scroll 0 5px transparent; + font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; + margin-top: 5px; + padding-left: 10px; + padding-top: 2px; +} + +div.toc h3 { + font: bold 12px/1.2 Arial,FreeSans,sans-serif; + color: ##60; + border-bottom: 0 none; + margin: 0; +} + +div.toc ul { + list-style: none outside none; + border: medium none; + padding: 0px; +} + +div.toc li.level1 { + margin-left: 0px; +} + +div.toc li.level2 { + margin-left: 15px; +} + +div.toc li.level3 { + margin-left: 30px; +} + +div.toc li.level4 { + margin-left: 45px; +} + +.inherit_header { + font-weight: bold; + color: gray; + cursor: pointer; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.inherit_header td { + padding: 6px 0px 2px 5px; +} + +.inherit { + display: none; +} + +tr.heading h2 { + margin-top: 12px; + margin-bottom: 4px; +} + +/* tooltip related style info */ + +.ttc { + position: absolute; + display: none; +} + +#powerTip { + cursor: default; + white-space: nowrap; + background-color: white; + border: 1px solid gray; + border-radius: 4px 4px 4px 4px; + box-shadow: 1px 1px 7px gray; + display: none; + font-size: smaller; + max-width: 80%; + opacity: 0.9; + padding: 1ex 1em 1em; + position: absolute; + z-index: 2147483647; +} + +#powerTip div.ttdoc { + color: grey; + font-style: italic; +} + +#powerTip div.ttname a { + font-weight: bold; +} + +#powerTip div.ttname { + font-weight: bold; +} + +#powerTip div.ttdeci { + color: #006318; +} + +#powerTip div { + margin: 0px; + padding: 0px; + font: 12px/16px Roboto,sans-serif; +} + +#powerTip:before, #powerTip:after { + content: ""; + position: absolute; + margin: 0px; +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.s:after, #powerTip.s:before, +#powerTip.w:after, #powerTip.w:before, +#powerTip.e:after, #powerTip.e:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.nw:after, #powerTip.nw:before, +#powerTip.sw:after, #powerTip.sw:before { + border: solid transparent; + content: " "; + height: 0; + width: 0; + position: absolute; +} + +#powerTip.n:after, #powerTip.s:after, +#powerTip.w:after, #powerTip.e:after, +#powerTip.nw:after, #powerTip.ne:after, +#powerTip.sw:after, #powerTip.se:after { + border-color: rgba(255, 255, 255, 0); +} + +#powerTip.n:before, #powerTip.s:before, +#powerTip.w:before, #powerTip.e:before, +#powerTip.nw:before, #powerTip.ne:before, +#powerTip.sw:before, #powerTip.se:before { + border-color: rgba(128, 128, 128, 0); +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.nw:after, #powerTip.nw:before { + top: 100%; +} + +#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after { + border-top-color: #ffffff; + border-width: 10px; + margin: 0px -10px; +} +#powerTip.n:before { + border-top-color: #808080; + border-width: 11px; + margin: 0px -11px; +} +#powerTip.n:after, #powerTip.n:before { + left: 50%; +} + +#powerTip.nw:after, #powerTip.nw:before { + right: 14px; +} + +#powerTip.ne:after, #powerTip.ne:before { + left: 14px; +} + +#powerTip.s:after, #powerTip.s:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.sw:after, #powerTip.sw:before { + bottom: 100%; +} + +#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after { + border-bottom-color: #ffffff; + border-width: 10px; + margin: 0px -10px; +} + +#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before { + border-bottom-color: #808080; + border-width: 11px; + margin: 0px -11px; +} + +#powerTip.s:after, #powerTip.s:before { + left: 50%; +} + +#powerTip.sw:after, #powerTip.sw:before { + right: 14px; +} + +#powerTip.se:after, #powerTip.se:before { + left: 14px; +} + +#powerTip.e:after, #powerTip.e:before { + left: 100%; +} +#powerTip.e:after { + border-left-color: #ffffff; + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.e:before { + border-left-color: #808080; + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +#powerTip.w:after, #powerTip.w:before { + right: 100%; +} +#powerTip.w:after { + border-right-color: #ffffff; + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.w:before { + border-right-color: #808080; + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +@media print +{ + #top { display: none; } + #side-nav { display: none; } + #nav-path { display: none; } + body { overflow:visible; } + h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } + .summary { display: none; } + .memitem { page-break-inside: avoid; } + #doc-content + { + margin-left:0 !important; + height:auto !important; + width:auto !important; + overflow:inherit; + display:inline; + } +} + +/*custom header*/ + +#header{ + -webkit-border-top-left-radius: 8px; + -webkit-border-top-right-radius: 8px; + -moz-border-radius-topleft: 8px; + -moz-border-radius-topright: 8px; + -webkit-border-bottom-left-radius: 8px; + -webkit-border-bottom-right-radius: 8px; + -moz-border-radius-bottomleft: 8px; + -moz-border-radius-bottomright: 8px; + background-color: #313131; + background-image: linear-gradient(top, #666666 0%, #313131 100%); + background-image: -ms-linear-gradient(top, #666666 0%, #313131 100%); + background-image: -o-linear-gradient(top, #666666 0%, #313131 100%); + background-image: -webkit-gradient(linear, left top, left bottom, from(#666), to(#313131)); + background-image: -moz-linear-gradient(top, #666, #313131); + box-shadow: 2px 2px 4px 2px #666; + -moz-box-shadow: 2px 2px 4px 2px #666; + -webkit-box-shadow: 2px 2px 4px 2px #666; +} + +#header img { + margin: 16px 0 0 48px; +} + +#header a{ + color: #FFFFFF; +} + +#header a:hover{ + color: #72cf3d; +} + +#header .first{ + -webkit-border-top-left-radius: 8px; + -webkit-border-top-right-radius: 8px; + -moz-border-radius-topleft: 8px; + -moz-border-radius-topright: 8px; + color: #313131; + background-image: linear-gradient(top, #aaaaaa 0%, #666666 100%); + background-image: -ms-linear-gradient(top, #aaaaaa 0%, #666666 100%); + background-image: -o-linear-gradient(top, #aaaaaa 0%, #666666 100%); + background-image: -webkit-gradient(linear, left top, left bottom, from(#aaaaaa), to(#666666)); + background-image: -moz-linear-gradient(top, #aaaaaa, #666666); + height: 16px; +} + +#header .second{ + -webkit-border-bottom-left-radius: 8px; + -webkit-border-bottom-right-radius: 8px; + -moz-border-radius-bottomleft: 8px; + -moz-border-radius-bottomright: 8px; + color: #313131; + background-image: linear-gradient(top, #313131 0%, #11111 100%); + background-image: -ms-linear-gradient(top, #313131 0%, #111111 100%); + background-image: -o-linear-gradient(top, #313131 0%, #11111 100%); + background-image: -webkit-gradient(linear, left top, left bottom, from(#313131), to(#111)); + background-image: -moz-linear-gradient(top, #313131, #111); + height: 16px; +} + + diff --git a/docs/api/files/_nv_flow_8h-source.html b/docs/api/files/_nv_flow_8h-source.html new file mode 100644 index 0000000..87a3bd0 --- /dev/null +++ b/docs/api/files/_nv_flow_8h-source.html @@ -0,0 +1,1039 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlow.h Source File + + + + + + + + + +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/_nv_flow_8h.html b/docs/api/files/_nv_flow_8h.html new file mode 100644 index 0000000..8b433d0 --- /dev/null +++ b/docs/api/files/_nv_flow_8h.html @@ -0,0 +1,541 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlow.h File Reference + + + + + + + + +
+

NvFlow.h File Reference

#include "NvFlowContext.h"
+#include "NvFlowShader.h"
+ +

+Go to the source code of this file. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowColorMapData
 Required information for writing to a CPU mapped color map. More...
struct  NvFlowCrossSectionDesc
 Description required to create cross section object. More...
struct  NvFlowCrossSectionParams
 Parameters needed to render cross section. More...
struct  NvFlowDeviceDesc
 Description required for creating a Flow device. More...
struct  NvFlowDeviceQueueDesc
 Description required for creating a Flow device queue. More...
struct  NvFlowDeviceQueueStatus
 Flow device queue status to allow app to throttle maximum queued work. More...
struct  NvFlowGridDesc
 Description required to create a grid. More...
struct  NvFlowGridEmitCustomAllocParams
 Necessary parameters/resources for custom grid block allocation. More...
struct  NvFlowGridEmitCustomEmitLayerParams
 Necessary parameters/resources for custom emit operations. More...
struct  NvFlowGridEmitCustomEmitParams
 Handle for requesting per layer emitter data. More...
struct  NvFlowGridEmitParams
 Parameters for both emission and collision. More...
struct  NvFlowGridExportDebugVisView
 Debug vis data. More...
struct  NvFlowGridExportHandle
 Texture channel export handle. More...
struct  NvFlowGridExportImportLayeredMapping
 Description applying to all exported layers. More...
struct  NvFlowGridExportImportLayerMapping
 Description of a single exported layer. More...
struct  NvFlowGridExportLayeredView
 Description applying to all exported layers. More...
struct  NvFlowGridExportLayerView
 Description of a single exported layer. More...
struct  NvFlowGridExportSimpleShape
 Data to visualize simple shape. More...
struct  NvFlowGridImportDesc
 Description required to create GridImport. More...
struct  NvFlowGridImportHandle
 Texture channel handle. More...
struct  NvFlowGridImportLayeredView
 Description applying to all imported layers. More...
struct  NvFlowGridImportLayerView
 Description of a single imported layer. More...
struct  NvFlowGridImportParams
 Parameters for grabbing import view. More...
struct  NvFlowGridImportStateCPUParams
 Parameters for grabbing import view. More...
struct  NvFlowGridMaterialHandle
 Handle provided by grid to reference materials. More...
struct  NvFlowGridMaterialParams
 Grid material parameters. More...
struct  NvFlowGridMaterialPerComponent
 Grid material per component parameters. More...
struct  NvFlowGridParams
 Parameters controlling grid behavior. More...
struct  NvFlowGridProxyDesc
 Parameters need to create a grid proxy. More...
struct  NvFlowGridProxyFlushParams
 Parameters need to create a multi-GPU proxy. More...
struct  NvFlowGridResetDesc
 Description required to reset a NvFlowGrid. More...
struct  NvFlowParticleSurfaceData
 Particle data. More...
struct  NvFlowParticleSurfaceDesc
 Description for creation. More...
struct  NvFlowParticleSurfaceEmitParams
 Parameter for surface emission. More...
struct  NvFlowParticleSurfaceParams
 Parameters for update. More...
struct  NvFlowQueryTime
 CPU/GPU timing info. More...
struct  NvFlowRenderMaterialHandle
 A handle to a volume render material. More...
struct  NvFlowRenderMaterialParams
 Per material parameters for Flow grid rendering. More...
struct  NvFlowRenderMaterialPoolDesc
 Description necessary to create render material. More...
struct  NvFlowSDFGenDesc
 Description required for creating a signed distance field generator. More...
struct  NvFlowSDFGenMeshParams
 Simple mesh description. More...
union  NvFlowShapeDesc
 Shared type for shape descriptions. More...
struct  NvFlowShapeDescBox
 Description of a box. More...
struct  NvFlowShapeDescCapsule
 Description of a capsule. More...
struct  NvFlowShapeDescPlane
 Description of a plane. More...
struct  NvFlowShapeDescSDF
 Description of a signed distance field shape. More...
struct  NvFlowShapeDescSphere
 Desription of a sphere. More...
struct  NvFlowShapeSDFData
 Required information for writing to a CPU mapped signed distance field. More...
struct  NvFlowShapeSDFDesc
 Description required to create a signed distance field object. More...
struct  NvFlowSupport
 Description of feature support on the queried Flow context GPU. More...
struct  NvFlowVolumeLightingParams
 Parameters for Flow grid lighting. More...
struct  NvFlowVolumeRenderDesc
 Description needed to a create a volume render object. More...
struct  NvFlowVolumeRenderLMSParams
 Parameters for VRWorks lens matched shading rendering. More...
struct  NvFlowVolumeRenderMultiResParams
 Parameters for VRWorks multires rendering. More...
struct  NvFlowVolumeRenderParams
 Parameters for Flow grid rendering. More...
struct  NvFlowVolumeRenderViewport
 Rendering viewport. More...
struct  NvFlowVolumeShadowDebugRenderParams
 Parameters required to visualize shadow block allocation. More...
struct  NvFlowVolumeShadowDesc
 Description required to create volume shadow object. More...
struct  NvFlowVolumeShadowParams
 Parameters required to update volume shadows. More...
struct  NvFlowVolumeShadowStats
 Stats on currently active volume shadow. More...

Typedefs

typedef void(* NvFlowGridEmitCustomAllocFunc )(void *userdata, const NvFlowGridEmitCustomAllocParams *params)
typedef void(* NvFlowGridEmitCustomEmitFunc )(void *userdata, NvFlowUint *dataFrontIdx, const NvFlowGridEmitCustomEmitParams *params)

Enumerations

enum  NvFlowDeviceMode { eNvFlowDeviceModeProxy = 0, +eNvFlowDeviceModeUnique = 1 + }
 Device Type. More...
enum  NvFlowDeviceQueueType { eNvFlowDeviceQueueTypeGraphics = 0, +eNvFlowDeviceQueueTypeCompute = 1, +eNvFlowDeviceQueueTypeCopy = 2 + }
 Types of queues. More...
enum  NvFlowGridComponent {
+  eNvFlowGridComponentVelocity = 0, +eNvFlowGridComponentSmoke = 1, +eNvFlowGridComponentTemperature = 2, +eNvFlowGridComponentFuel = 3, +
+  eNvFlowGridNumComponents = 4 +
+ }
 Grid component IDs. More...
enum  NvFlowGridDebugVisFlags {
+  eNvFlowGridDebugVisDisabled = 0x00, +eNvFlowGridDebugVisBlocks = 0x01, +eNvFlowGridDebugVisEmitBounds = 0x02, +eNvFlowGridDebugVisShapesSimple = 0x04, +
+  eNvFlowGridDebugVisCount +
+ }
 Flags to control grid debug visualization. More...
enum  NvFlowGridEmitMode {
+  eNvFlowGridEmitModeDefault = 0, +eNvFlowGridEmitModeDisableVelocity = 0x01, +eNvFlowGridEmitModeDisableDensity = 0x02, +eNvFlowGridEmitModeDisableAlloc = 0x04, +
+  eNvFlowGridEmitModeAllocShape = 0x08, +eNvFlowGridEmitModeAllocShapeOnly = 0x0F +
+ }
 Emitter modes. More...
enum  NvFlowGridImportMode { eNvFlowGridImportModePoint = 0, +eNvFlowGridImportModeLinear = 1 + }
 Grid import modes. More...
enum  NvFlowGridProxyType { eNvFlowGridProxyTypePassThrough = 0, +eNvFlowGridProxyTypeMultiGPU = 1, +eNvFlowGridProxyTypeInterQueue = 2 + }
 Proxy types. More...
enum  NvFlowGridTextureChannel { eNvFlowGridTextureChannelVelocity = 0, +eNvFlowGridTextureChannelDensity = 1, +eNvFlowGridTextureChannelDensityCoarse = 2, +eNvFlowGridTextureChannelCount + }
 Grid texture channel, four components per channel. More...
enum  NvFlowMultiRes { eNvFlowMultiRes1x1x1 = 0, +eNvFlowMultiRes2x2x2 = 1 + }
 Enumeration used to describe density texture channel resolution relative to velocity resolution. More...
enum  NvFlowMultiResRayMarch {
+  eNvFlowMultiResRayMarchDisabled = 0, +eNvFlowMultiResRayMarch2x2 = 1, +eNvFlowMultiResRayMarch4x4 = 2, +eNvFlowMultiResRayMarch8x8 = 3, +
+  eNvFlowMultiResRayMarch16x16 = 4 +
+ }
 Multiple resolution options for offscreen ray march. More...
enum  NvFlowShapeType {
+  eNvFlowShapeTypeSDF = 0, +eNvFlowShapeTypeSphere = 1, +eNvFlowShapeTypeBox = 2, +eNvFlowShapeTypeCapsule = 3, +
+  eNvFlowShapeTypePlane = 4 +
+ }
 Types of shapes for emit/collide behavior. More...
enum  NvFlowVolumeRenderDownsample { eNvFlowVolumeRenderDownsampleNone = 0, +eNvFlowVolumeRenderDownsample2x2 = 1 + }
 Downsample options for offscreen ray march. More...
enum  NvFlowVolumeRenderMode {
+  eNvFlowVolumeRenderMode_colormap = 0, +eNvFlowVolumeRenderMode_raw = 1, +eNvFlowVolumeRenderMode_rainbow = 2, +eNvFlowVolumeRenderMode_debug = 3, +
+  eNvFlowVolumeRenderModeCount +
+ }
 Render modes. More...

Functions

NvFlowCrossSection * NvFlowCreateCrossSection (NvFlowContext *context, const NvFlowCrossSectionDesc *desc)
NvFlowDevice * NvFlowCreateDevice (NvFlowContext *renderContext, const NvFlowDeviceDesc *desc)
NvFlowDeviceQueue * NvFlowCreateDeviceQueue (NvFlowDevice *device, const NvFlowDeviceQueueDesc *desc)
NvFlowGrid * NvFlowCreateGrid (NvFlowContext *context, const NvFlowGridDesc *desc)
NvFlowGridImport * NvFlowCreateGridImport (NvFlowContext *context, const NvFlowGridImportDesc *desc)
NvFlowGridImportStateCPU * NvFlowCreateGridImportStateCPU (NvFlowGridImport *gridImport)
NvFlowGridProxy * NvFlowCreateGridProxy (const NvFlowGridProxyDesc *desc)
NvFlowParticleSurface * NvFlowCreateParticleSurface (NvFlowContext *context, const NvFlowParticleSurfaceDesc *desc)
NvFlowRenderMaterialHandle NvFlowCreateRenderMaterial (NvFlowContext *context, NvFlowRenderMaterialPool *pool, const NvFlowRenderMaterialParams *params)
NvFlowRenderMaterialPool * NvFlowCreateRenderMaterialPool (NvFlowContext *context, const NvFlowRenderMaterialPoolDesc *desc)
NvFlowSDFGen * NvFlowCreateSDFGen (NvFlowContext *context, const NvFlowSDFGenDesc *desc)
NvFlowShapeSDF * NvFlowCreateShapeSDF (NvFlowContext *context, const NvFlowShapeSDFDesc *desc)
NvFlowShapeSDF * NvFlowCreateShapeSDFFromTexture3D (NvFlowContext *context, NvFlowTexture3D *texture)
NvFlowVolumeRender * NvFlowCreateVolumeRender (NvFlowContext *context, const NvFlowVolumeRenderDesc *desc)
NvFlowVolumeShadow * NvFlowCreateVolumeShadow (NvFlowContext *context, const NvFlowVolumeShadowDesc *desc)
void NvFlowCrossSectionParamsDefaults (NvFlowCrossSectionParams *params)
void NvFlowCrossSectionRender (NvFlowCrossSection *crossSection, NvFlowContext *context, const NvFlowCrossSectionParams *params)
bool NvFlowDedicatedDeviceAvailable (NvFlowContext *renderContext)
bool NvFlowDedicatedDeviceQueueAvailable (NvFlowContext *renderContext)
void NvFlowDeviceDescDefaults (NvFlowDeviceDesc *desc)
void NvFlowDeviceQueueConditionalFlush (NvFlowDeviceQueue *deviceQueue, NvFlowContext *context)
NvFlowContext * NvFlowDeviceQueueCreateContext (NvFlowDeviceQueue *deviceQueue)
void NvFlowDeviceQueueFlush (NvFlowDeviceQueue *deviceQueue, NvFlowContext *context)
void NvFlowDeviceQueueUpdateContext (NvFlowDeviceQueue *deviceQueue, NvFlowContext *context, NvFlowDeviceQueueStatus *status)
void NvFlowDeviceQueueWaitOnFence (NvFlowDeviceQueue *deviceQueue, NvFlowContext *context, NvFlowUint64 fenceValue)
NvFlowRenderMaterialHandle NvFlowGetDefaultRenderMaterial (NvFlowRenderMaterialPool *pool)
NvFlowGridMaterialHandle NvFlowGridCreateMaterial (NvFlowGrid *grid, const NvFlowGridMaterialParams *params)
void NvFlowGridDescDefaults (NvFlowGridDesc *desc)
void NvFlowGridEmit (NvFlowGrid *grid, const NvFlowShapeDesc *shapes, NvFlowUint numShapes, const NvFlowGridEmitParams *params, NvFlowUint numParams)
void NvFlowGridEmitCustomGetLayerParams (const NvFlowGridEmitCustomEmitParams *emitParams, NvFlowUint layerIdx, NvFlowGridEmitCustomEmitLayerParams *emitLayerParams)
void NvFlowGridEmitCustomRegisterAllocFunc (NvFlowGrid *grid, NvFlowGridEmitCustomAllocFunc func, void *userdata)
void NvFlowGridEmitCustomRegisterEmitFunc (NvFlowGrid *grid, NvFlowGridTextureChannel channel, NvFlowGridEmitCustomEmitFunc func, void *userdata)
void NvFlowGridEmitParamsDefaults (NvFlowGridEmitParams *params)
void NvFlowGridExportGetDebugVisView (NvFlowGridExport *gridExport, NvFlowGridExportDebugVisView *view)
NvFlowGridExportHandle NvFlowGridExportGetHandle (NvFlowGridExport *gridExport, NvFlowContext *context, NvFlowGridTextureChannel channel)
void NvFlowGridExportGetLayeredView (NvFlowGridExportHandle handle, NvFlowGridExportLayeredView *layeredView)
void NvFlowGridExportGetLayerView (NvFlowGridExportHandle handle, NvFlowUint layerIdx, NvFlowGridExportLayerView *layerView)
NvFlowGridMaterialHandle NvFlowGridGetDefaultMaterial (NvFlowGrid *grid)
NvFlowGridExport * NvFlowGridGetGridExport (NvFlowContext *context, NvFlowGrid *grid)
void NvFlowGridGPUMemUsage (NvFlowGrid *grid, NvFlowUint64 *numBytes)
NvFlowGridExport * NvFlowGridImportGetGridExport (NvFlowGridImport *gridImport, NvFlowContext *context)
NvFlowGridImportHandle NvFlowGridImportGetHandle (NvFlowGridImport *gridImport, NvFlowContext *context, const NvFlowGridImportParams *params)
void NvFlowGridImportGetLayeredView (NvFlowGridImportHandle handle, NvFlowGridImportLayeredView *layeredView)
void NvFlowGridImportGetLayerView (NvFlowGridImportHandle handle, NvFlowUint layerIdx, NvFlowGridImportLayerView *layerView)
void NvFlowGridImportReleaseChannel (NvFlowGridImport *gridImport, NvFlowContext *context, NvFlowGridTextureChannel channel)
NvFlowGridImportHandle NvFlowGridImportStateCPUGetHandle (NvFlowGridImport *gridImport, NvFlowContext *context, const NvFlowGridImportStateCPUParams *params)
void NvFlowGridImportUpdateStateCPU (NvFlowGridImportStateCPU *stateCPU, NvFlowContext *context, NvFlowGridExport *gridExport)
void NvFlowGridMaterialParamsDefaults (NvFlowGridMaterialParams *params)
void NvFlowGridParamsDefaults (NvFlowGridParams *params)
void NvFlowGridProxyFlush (NvFlowGridProxy *proxy, const NvFlowGridProxyFlushParams *params)
NvFlowGridExport * NvFlowGridProxyGetGridExport (NvFlowGridProxy *proxy, NvFlowContext *renderContext)
void NvFlowGridProxyPush (NvFlowGridProxy *proxy, NvFlowGridExport *gridExport, const NvFlowGridProxyFlushParams *params)
NvFlowResult NvFlowGridQuerySupport (NvFlowGrid *grid, NvFlowContext *context, NvFlowSupport *support)
NvFlowResult NvFlowGridQueryTime (NvFlowGrid *grid, NvFlowQueryTime *gpuTime, NvFlowQueryTime *cpuTime)
void NvFlowGridReleaseMaterial (NvFlowGrid *grid, NvFlowGridMaterialHandle material)
void NvFlowGridReset (NvFlowGrid *grid, const NvFlowGridResetDesc *desc)
void NvFlowGridResetDescDefaults (NvFlowGridResetDesc *desc)
void NvFlowGridSetMaterialParams (NvFlowGrid *grid, NvFlowGridMaterialHandle material, const NvFlowGridMaterialParams *params)
void NvFlowGridSetParams (NvFlowGrid *grid, const NvFlowGridParams *params)
void NvFlowGridSetTargetLocation (NvFlowGrid *grid, NvFlowFloat3 targetLocation)
void NvFlowGridUpdate (NvFlowGrid *grid, NvFlowContext *context, float dt)
void NvFlowGridUpdateEmitSDFs (NvFlowGrid *grid, NvFlowShapeSDF **sdfs, NvFlowUint numSdfs)
void NvFlowParticleSurfaceAllocFunc (NvFlowParticleSurface *surface, NvFlowContext *context, const NvFlowGridEmitCustomAllocParams *params)
NvFlowGridExport * NvFlowParticleSurfaceDebugGridExport (NvFlowParticleSurface *surface, NvFlowContext *context)
void NvFlowParticleSurfaceEmitDensityFunc (NvFlowParticleSurface *surface, NvFlowContext *context, NvFlowUint *dataFrontIdx, const NvFlowGridEmitCustomEmitParams *params, const NvFlowParticleSurfaceEmitParams *emitParams)
void NvFlowParticleSurfaceEmitVelocityFunc (NvFlowParticleSurface *surface, NvFlowContext *context, NvFlowUint *dataFrontIdx, const NvFlowGridEmitCustomEmitParams *params, const NvFlowParticleSurfaceEmitParams *emitParams)
void NvFlowParticleSurfaceUpdateParticles (NvFlowParticleSurface *surface, NvFlowContext *context, const NvFlowParticleSurfaceData *data)
void NvFlowParticleSurfaceUpdateSurface (NvFlowParticleSurface *surface, NvFlowContext *context, const NvFlowParticleSurfaceParams *params)
void NvFlowReleaseCrossSection (NvFlowCrossSection *crossSection)
void NvFlowReleaseDevice (NvFlowDevice *device)
void NvFlowReleaseDeviceQueue (NvFlowDeviceQueue *deviceQueue)
void NvFlowReleaseGrid (NvFlowGrid *grid)
void NvFlowReleaseGridImport (NvFlowGridImport *gridImport)
void NvFlowReleaseGridImportStateCPU (NvFlowGridImportStateCPU *stateCPU)
void NvFlowReleaseGridProxy (NvFlowGridProxy *proxy)
void NvFlowReleaseParticleSurface (NvFlowParticleSurface *surface)
void NvFlowReleaseRenderMaterial (NvFlowRenderMaterialHandle handle)
void NvFlowReleaseRenderMaterialPool (NvFlowRenderMaterialPool *pool)
void NvFlowReleaseSDFGen (NvFlowSDFGen *sdfGen)
void NvFlowReleaseShapeSDF (NvFlowShapeSDF *shape)
void NvFlowReleaseVolumeRender (NvFlowVolumeRender *volumeRender)
void NvFlowReleaseVolumeShadow (NvFlowVolumeShadow *volumeShadow)
NvFlowColorMapData NvFlowRenderMaterialColorMap (NvFlowContext *context, NvFlowRenderMaterialHandle handle)
void NvFlowRenderMaterialColorUnmap (NvFlowContext *context, NvFlowRenderMaterialHandle handle)
void NvFlowRenderMaterialParamsDefaults (NvFlowRenderMaterialParams *params)
void NvFlowRenderMaterialUpdate (NvFlowRenderMaterialHandle handle, const NvFlowRenderMaterialParams *params)
void NvFlowSDFGenReset (NvFlowSDFGen *sdfGen, NvFlowContext *context)
NvFlowTexture3D * NvFlowSDFGenShape (NvFlowSDFGen *sdfGen, NvFlowContext *context)
void NvFlowSDFGenUpdate (NvFlowSDFGen *sdfGen, NvFlowContext *context)
void NvFlowSDFGenVoxelize (NvFlowSDFGen *sdfGen, NvFlowContext *context, const NvFlowSDFGenMeshParams *params)
void NvFlowShapeSDFDescDefaults (NvFlowShapeSDFDesc *desc)
NvFlowShapeSDFData NvFlowShapeSDFMap (NvFlowShapeSDF *shape, NvFlowContext *context)
void NvFlowShapeSDFUnmap (NvFlowShapeSDF *shape, NvFlowContext *context)
void NvFlowVolumeRenderGridExport (NvFlowVolumeRender *volumeRender, NvFlowContext *context, NvFlowGridExport *gridExport, const NvFlowVolumeRenderParams *params)
NvFlowGridExport * NvFlowVolumeRenderLightGridExport (NvFlowVolumeRender *volumeRender, NvFlowContext *context, NvFlowGridExport *gridExport, const NvFlowVolumeLightingParams *params)
void NvFlowVolumeRenderParamsDefaults (NvFlowVolumeRenderParams *params)
void NvFlowVolumeRenderTexture3D (NvFlowVolumeRender *volumeRender, NvFlowContext *context, NvFlowTexture3D *density, const NvFlowVolumeRenderParams *params)
void NvFlowVolumeShadowDebugRender (NvFlowVolumeShadow *volumeShadow, NvFlowContext *context, const NvFlowVolumeShadowDebugRenderParams *params)
NvFlowGridExport * NvFlowVolumeShadowGetGridExport (NvFlowVolumeShadow *volumeShadow, NvFlowContext *context)
void NvFlowVolumeShadowGetStats (NvFlowVolumeShadow *volumeShadow, NvFlowVolumeShadowStats *stats)
void NvFlowVolumeShadowUpdate (NvFlowVolumeShadow *volumeShadow, NvFlowContext *context, NvFlowGridExport *gridExport, const NvFlowVolumeShadowParams *params)
+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/_nv_flow_context_8h-source.html b/docs/api/files/_nv_flow_context_8h-source.html new file mode 100644 index 0000000..669a23c --- /dev/null +++ b/docs/api/files/_nv_flow_context_8h-source.html @@ -0,0 +1,96 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowContext.h Source File + + + + + + + + + +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/_nv_flow_context_8h.html b/docs/api/files/_nv_flow_context_8h.html new file mode 100644 index 0000000..31100be --- /dev/null +++ b/docs/api/files/_nv_flow_context_8h.html @@ -0,0 +1,122 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowContext.h File Reference + + + + + + + + +
+

NvFlowContext.h File Reference

#include "NvFlowTypes.h"
+ +

+Go to the source code of this file. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Defines

#define NV_FLOW_VERSION   0x00010000

Enumerations

enum  NvFlowContextAPI { eNvFlowContextD3D11 = 1, +eNvFlowContextD3D12 = 2 + }
 API type. More...

Functions

bool NvFlowContextFlushRequestPop (NvFlowContext *context)
void NvFlowContextFlushRequestPush (NvFlowContext *context)
NvFlowContextAPI NvFlowContextGetContextType (NvFlowContext *context)
void NvFlowContextPop (NvFlowContext *context)
void NvFlowContextProcessFenceSignal (NvFlowContext *context)
void NvFlowContextProcessFenceWait (NvFlowContext *context)
void NvFlowContextPush (NvFlowContext *context)
NvFlowUint NvFlowDeferredRelease (float timeoutMS)
void NvFlowReleaseContext (NvFlowContext *context)
void NvFlowReleaseDepthStencilView (NvFlowDepthStencilView *view)
void NvFlowReleaseRenderTargetView (NvFlowRenderTargetView *view)
void NvFlowSetFreeFunc (void(*free)(void *ptr))
void NvFlowSetMallocFunc (void *(*malloc)(size_t size))
+

Define Documentation

+ +
+
+ + + + +
#define NV_FLOW_VERSION   0x00010000
+
+
+ +

+ +

+

+

Enumeration Type Documentation

+ +
+
+ + + + +
enum NvFlowContextAPI
+
+
+ +

+API type. +

+

Enumerator:
+ + + +
eNvFlowContextD3D11  +
eNvFlowContextD3D12  +
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/_nv_flow_context_d3_d11_8h-source.html b/docs/api/files/_nv_flow_context_d3_d11_8h-source.html new file mode 100644 index 0000000..fbcbd7e --- /dev/null +++ b/docs/api/files/_nv_flow_context_d3_d11_8h-source.html @@ -0,0 +1,98 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowContextD3D11.h Source File + + + + + + + + + +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/_nv_flow_context_d3_d11_8h.html b/docs/api/files/_nv_flow_context_d3_d11_8h.html new file mode 100644 index 0000000..b6c0df4 --- /dev/null +++ b/docs/api/files/_nv_flow_context_d3_d11_8h.html @@ -0,0 +1,73 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowContextD3D11.h File Reference + + + + + + + + +
+

NvFlowContextD3D11.h File Reference

+

+Go to the source code of this file. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowContextDescD3D11
struct  NvFlowDepthStencilViewDescD3D11
struct  NvFlowRenderTargetViewDescD3D11
struct  NvFlowResourceRWViewDescD3D11
struct  NvFlowResourceViewDescD3D11

Functions

NvFlowContext * NvFlowCreateContextD3D11 (NvFlowUint version, const NvFlowContextDescD3D11 *desc)
NvFlowDepthStencilView * NvFlowCreateDepthStencilViewD3D11 (NvFlowContext *context, const NvFlowDepthStencilViewDescD3D11 *desc)
NvFlowRenderTargetView * NvFlowCreateRenderTargetViewD3D11 (NvFlowContext *context, const NvFlowRenderTargetViewDescD3D11 *desc)
void NvFlowUpdateContextD3D11 (NvFlowContext *context, const NvFlowContextDescD3D11 *desc)
void NvFlowUpdateContextDescD3D11 (NvFlowContext *context, NvFlowContextDescD3D11 *desc)
void NvFlowUpdateDepthStencilViewD3D11 (NvFlowContext *context, NvFlowDepthStencilView *view, const NvFlowDepthStencilViewDescD3D11 *desc)
void NvFlowUpdateRenderTargetViewD3D11 (NvFlowContext *context, NvFlowRenderTargetView *view, const NvFlowRenderTargetViewDescD3D11 *desc)
void NvFlowUpdateResourceRWViewDescD3D11 (NvFlowContext *context, NvFlowResourceRW *resourceRW, NvFlowResourceRWViewDescD3D11 *desc)
void NvFlowUpdateResourceViewDescD3D11 (NvFlowContext *context, NvFlowResource *resource, NvFlowResourceViewDescD3D11 *desc)
+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/_nv_flow_context_d3_d12_8h-source.html b/docs/api/files/_nv_flow_context_d3_d12_8h-source.html new file mode 100644 index 0000000..f7ef24b --- /dev/null +++ b/docs/api/files/_nv_flow_context_d3_d12_8h-source.html @@ -0,0 +1,130 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowContextD3D12.h Source File + + + + + + + + + +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/_nv_flow_context_d3_d12_8h.html b/docs/api/files/_nv_flow_context_d3_d12_8h.html new file mode 100644 index 0000000..5ad7698 --- /dev/null +++ b/docs/api/files/_nv_flow_context_d3_d12_8h.html @@ -0,0 +1,77 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowContextD3D12.h File Reference + + + + + + + + +
+

NvFlowContextD3D12.h File Reference

+

+Go to the source code of this file. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowContextDescD3D12
struct  NvFlowDepthStencilViewDescD3D12
struct  NvFlowDescriptorReserveHandleD3D12
struct  NvFlowDynamicDescriptorHeapD3D12
struct  NvFlowRenderTargetViewDescD3D12
struct  NvFlowResourceRWViewDescD3D12
struct  NvFlowResourceViewDescD3D12

Functions

NvFlowContext * NvFlowCreateContextD3D12 (NvFlowUint version, const NvFlowContextDescD3D12 *desc)
NvFlowDepthStencilView * NvFlowCreateDepthStencilViewD3D12 (NvFlowContext *context, const NvFlowDepthStencilViewDescD3D12 *desc)
NvFlowRenderTargetView * NvFlowCreateRenderTargetViewD3D12 (NvFlowContext *context, const NvFlowRenderTargetViewDescD3D12 *desc)
void NvFlowUpdateContextD3D12 (NvFlowContext *context, const NvFlowContextDescD3D12 *desc)
void NvFlowUpdateContextDescD3D12 (NvFlowContext *context, NvFlowContextDescD3D12 *desc)
void NvFlowUpdateDepthStencilViewD3D12 (NvFlowContext *context, NvFlowDepthStencilView *view, const NvFlowDepthStencilViewDescD3D12 *desc)
void NvFlowUpdateRenderTargetViewD3D12 (NvFlowContext *context, NvFlowRenderTargetView *view, const NvFlowRenderTargetViewDescD3D12 *desc)
void NvFlowUpdateResourceRWViewDescD3D12 (NvFlowContext *context, NvFlowResourceRW *resourceRW, NvFlowResourceRWViewDescD3D12 *desc)
void NvFlowUpdateResourceViewDescD3D12 (NvFlowContext *context, NvFlowResource *resource, NvFlowResourceViewDescD3D12 *desc)
+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/_nv_flow_shader_8h-source.html b/docs/api/files/_nv_flow_shader_8h-source.html new file mode 100644 index 0000000..9736307 --- /dev/null +++ b/docs/api/files/_nv_flow_shader_8h-source.html @@ -0,0 +1,134 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowShader.h Source File + + + + + + + + + +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/_nv_flow_shader_8h.html b/docs/api/files/_nv_flow_shader_8h.html new file mode 100644 index 0000000..9db19b1 --- /dev/null +++ b/docs/api/files/_nv_flow_shader_8h.html @@ -0,0 +1,50 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowShader.h File Reference + + + + + + + + +
+

NvFlowShader.h File Reference

+

+Go to the source code of this file. + + + + + + + + +

Data Structures

struct  NvFlowShaderLinearParams
 Parameters for shaders using the linear format (linear interpolation). More...
struct  NvFlowShaderPointParams
 Parameters for shaders using the point format (no linear interpolation). More...
+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/_nv_flow_types_8h-source.html b/docs/api/files/_nv_flow_types_8h-source.html new file mode 100644 index 0000000..6356041 --- /dev/null +++ b/docs/api/files/_nv_flow_types_8h-source.html @@ -0,0 +1,135 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowTypes.h Source File + + + + + + + + + +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/_nv_flow_types_8h.html b/docs/api/files/_nv_flow_types_8h.html new file mode 100644 index 0000000..9a62eff --- /dev/null +++ b/docs/api/files/_nv_flow_types_8h.html @@ -0,0 +1,269 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowTypes.h File Reference + + + + + + + + +
+

NvFlowTypes.h File Reference

+

+Go to the source code of this file. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowDim
struct  NvFlowFloat3
struct  NvFlowFloat4
struct  NvFlowFloat4x4
struct  NvFlowUint2
struct  NvFlowUint3
struct  NvFlowUint4

Defines

#define NV_FLOW_API   extern "C" __declspec(dllexport)

Typedefs

typedef int NvFlowInt
typedef unsigned int NvFlowUint
typedef unsigned long long NvFlowUint64

Enumerations

enum  NvFlowFormat {
+  eNvFlowFormat_unknown = 0, +eNvFlowFormat_r32_float = 1, +eNvFlowFormat_r32g32_float = 2, +eNvFlowFormat_r32g32b32a32_float = 3, +
+  eNvFlowFormat_r16_float = 4, +eNvFlowFormat_r16g16_float = 5, +eNvFlowFormat_r16g16b16a16_float = 6, +eNvFlowFormat_r32_uint = 7, +
+  eNvFlowFormat_r32g32_uint = 8, +eNvFlowFormat_r32g32b32a32_uint = 9, +eNvFlowFormat_r8_unorm = 10, +eNvFlowFormat_r8g8_unorm = 11, +
+  eNvFlowFormat_r8g8b8a8_unorm = 12, +eNvFlowFormat_r16_unorm = 13, +eNvFlowFormat_r16g16_unorm = 14, +eNvFlowFormat_r16g16b16a16_unorm = 15, +
+  eNvFlowFormat_d32_float = 16, +eNvFlowFormat_d24_unorm_s8_uint = 17, +eNvFlowFormat_r8_snorm = 18, +eNvFlowFormat_r8g8_snorm = 19, +
+  eNvFlowFormat_r8g8b8a8_snorm = 20, +eNvFlowFormat_r32_typeless = 21, +eNvFlowFormat_r24_unorm_x8_typeless = 22, +eNvFlowFormat_r24g8_typeless = 23, +
+  eNvFlowFormat_r16_typeless = 24, +eNvFlowFormat_d16_unorm = 25, +eNvFlowFormat_max +
+ }
enum  NvFlowResult { eNvFlowSuccess = 0, +eNvFlowFail = 1 + }
+

Define Documentation

+ +
+
+ + + + +
#define NV_FLOW_API   extern "C" __declspec(dllexport)
+
+
+ +

+ +

+

+

Typedef Documentation

+ +
+
+ + + + +
typedef int NvFlowInt
+
+
+ +

+ +

+

+ +

+
+ + + + +
typedef unsigned int NvFlowUint
+
+
+ +

+ +

+

+ +

+
+ + + + +
typedef unsigned long long NvFlowUint64
+
+
+ +

+ +

+

+

Enumeration Type Documentation

+ +
+
+ + + + +
enum NvFlowFormat
+
+
+ +

+

Enumerator:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
eNvFlowFormat_unknown  +
eNvFlowFormat_r32_float  +
eNvFlowFormat_r32g32_float  +
eNvFlowFormat_r32g32b32a32_float  +
eNvFlowFormat_r16_float  +
eNvFlowFormat_r16g16_float  +
eNvFlowFormat_r16g16b16a16_float  +
eNvFlowFormat_r32_uint  +
eNvFlowFormat_r32g32_uint  +
eNvFlowFormat_r32g32b32a32_uint  +
eNvFlowFormat_r8_unorm  +
eNvFlowFormat_r8g8_unorm  +
eNvFlowFormat_r8g8b8a8_unorm  +
eNvFlowFormat_r16_unorm  +
eNvFlowFormat_r16g16_unorm  +
eNvFlowFormat_r16g16b16a16_unorm  +
eNvFlowFormat_d32_float  +
eNvFlowFormat_d24_unorm_s8_uint  +
eNvFlowFormat_r8_snorm  +
eNvFlowFormat_r8g8_snorm  +
eNvFlowFormat_r8g8b8a8_snorm  +
eNvFlowFormat_r32_typeless  +
eNvFlowFormat_r24_unorm_x8_typeless  +
eNvFlowFormat_r24g8_typeless  +
eNvFlowFormat_r16_typeless  +
eNvFlowFormat_d16_unorm  +
eNvFlowFormat_max  +
+
+ +
+

+ +

+
+ + + + +
enum NvFlowResult
+
+
+ +

+

Enumerator:
+ + + +
eNvFlowSuccess  +
eNvFlowFail  +
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/annotated.html b/docs/api/files/annotated.html new file mode 100644 index 0000000..b74bfd8 --- /dev/null +++ b/docs/api/files/annotated.html @@ -0,0 +1,115 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Structures + + + + + + + + +
+

Data Structures

Here are the data structures with brief descriptions: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NvFlowColorMapDataRequired information for writing to a CPU mapped color map
NvFlowContextDescD3D11
NvFlowContextDescD3D12
NvFlowCrossSectionDescDescription required to create cross section object
NvFlowCrossSectionParamsParameters needed to render cross section
NvFlowDepthStencilViewDescD3D11
NvFlowDepthStencilViewDescD3D12
NvFlowDescriptorReserveHandleD3D12
NvFlowDeviceDescDescription required for creating a Flow device
NvFlowDeviceQueueDescDescription required for creating a Flow device queue
NvFlowDeviceQueueStatusFlow device queue status to allow app to throttle maximum queued work
NvFlowDim
NvFlowDynamicDescriptorHeapD3D12
NvFlowFloat3
NvFlowFloat4
NvFlowFloat4x4
NvFlowGridDescDescription required to create a grid
NvFlowGridEmitCustomAllocParamsNecessary parameters/resources for custom grid block allocation
NvFlowGridEmitCustomEmitLayerParamsNecessary parameters/resources for custom emit operations
NvFlowGridEmitCustomEmitParamsHandle for requesting per layer emitter data
NvFlowGridEmitParamsParameters for both emission and collision
NvFlowGridExportDebugVisViewDebug vis data
NvFlowGridExportHandleTexture channel export handle
NvFlowGridExportImportLayeredMappingDescription applying to all exported layers
NvFlowGridExportImportLayerMappingDescription of a single exported layer
NvFlowGridExportLayeredViewDescription applying to all exported layers
NvFlowGridExportLayerViewDescription of a single exported layer
NvFlowGridExportSimpleShapeData to visualize simple shape
NvFlowGridImportDescDescription required to create GridImport
NvFlowGridImportHandleTexture channel handle
NvFlowGridImportLayeredViewDescription applying to all imported layers
NvFlowGridImportLayerViewDescription of a single imported layer
NvFlowGridImportParamsParameters for grabbing import view
NvFlowGridImportStateCPUParamsParameters for grabbing import view
NvFlowGridMaterialHandleHandle provided by grid to reference materials
NvFlowGridMaterialParamsGrid material parameters
NvFlowGridMaterialPerComponentGrid material per component parameters
NvFlowGridParamsParameters controlling grid behavior
NvFlowGridProxyDescParameters need to create a grid proxy
NvFlowGridProxyFlushParamsParameters need to create a multi-GPU proxy
NvFlowGridResetDescDescription required to reset a NvFlowGrid
NvFlowParticleSurfaceDataParticle data
NvFlowParticleSurfaceDescDescription for creation
NvFlowParticleSurfaceEmitParamsParameter for surface emission
NvFlowParticleSurfaceParamsParameters for update
NvFlowQueryTimeCPU/GPU timing info
NvFlowRenderMaterialHandleA handle to a volume render material
NvFlowRenderMaterialParamsPer material parameters for Flow grid rendering
NvFlowRenderMaterialPoolDescDescription necessary to create render material
NvFlowRenderTargetViewDescD3D11
NvFlowRenderTargetViewDescD3D12
NvFlowResourceRWViewDescD3D11
NvFlowResourceRWViewDescD3D12
NvFlowResourceViewDescD3D11
NvFlowResourceViewDescD3D12
NvFlowSDFGenDescDescription required for creating a signed distance field generator
NvFlowSDFGenMeshParamsSimple mesh description
NvFlowShaderLinearParamsParameters for shaders using the linear format (linear interpolation)
NvFlowShaderPointParamsParameters for shaders using the point format (no linear interpolation)
NvFlowShapeDescShared type for shape descriptions
NvFlowShapeDescBoxDescription of a box
NvFlowShapeDescCapsuleDescription of a capsule
NvFlowShapeDescPlaneDescription of a plane
NvFlowShapeDescSDFDescription of a signed distance field shape
NvFlowShapeDescSphereDesription of a sphere
NvFlowShapeSDFDataRequired information for writing to a CPU mapped signed distance field
NvFlowShapeSDFDescDescription required to create a signed distance field object
NvFlowSupportDescription of feature support on the queried Flow context GPU
NvFlowUint2
NvFlowUint3
NvFlowUint4
NvFlowVolumeLightingParamsParameters for Flow grid lighting
NvFlowVolumeRenderDescDescription needed to a create a volume render object
NvFlowVolumeRenderLMSParamsParameters for VRWorks lens matched shading rendering
NvFlowVolumeRenderMultiResParamsParameters for VRWorks multires rendering
NvFlowVolumeRenderParamsParameters for Flow grid rendering
NvFlowVolumeRenderViewportRendering viewport
NvFlowVolumeShadowDebugRenderParamsParameters required to visualize shadow block allocation
NvFlowVolumeShadowDescDescription required to create volume shadow object
NvFlowVolumeShadowParamsParameters required to update volume shadows
NvFlowVolumeShadowStatsStats on currently active volume shadow
+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/classes.html b/docs/api/files/classes.html new file mode 100644 index 0000000..cd67adb --- /dev/null +++ b/docs/api/files/classes.html @@ -0,0 +1,36 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Alphabetical List + + + + + + + + +
+

Data Structure Index

N

+ +
  N  
+		NvFlowGridDesc   NvFlowGridImportStateCPUParams   NvFlowRenderTargetViewDescD3D11   NvFlowShapeSDFData   
NvFlowColorMapData   NvFlowGridEmitCustomAllocParams   NvFlowGridMaterialHandle   NvFlowRenderTargetViewDescD3D12   NvFlowShapeSDFDesc   
NvFlowContextDescD3D11   NvFlowGridEmitCustomEmitLayerParams   NvFlowGridMaterialParams   NvFlowResourceRWViewDescD3D11   NvFlowSupport   
NvFlowContextDescD3D12   NvFlowGridEmitCustomEmitParams   NvFlowGridMaterialPerComponent   NvFlowResourceRWViewDescD3D12   NvFlowUint2   
NvFlowCrossSectionDesc   NvFlowGridEmitParams   NvFlowGridParams   NvFlowResourceViewDescD3D11   NvFlowUint3   
NvFlowCrossSectionParams   NvFlowGridExportDebugVisView   NvFlowGridProxyDesc   NvFlowResourceViewDescD3D12   NvFlowUint4   
NvFlowDepthStencilViewDescD3D11   NvFlowGridExportHandle   NvFlowGridProxyFlushParams   NvFlowSDFGenDesc   NvFlowVolumeLightingParams   
NvFlowDepthStencilViewDescD3D12   NvFlowGridExportImportLayeredMapping   NvFlowGridResetDesc   NvFlowSDFGenMeshParams   NvFlowVolumeRenderDesc   
NvFlowDescriptorReserveHandleD3D12   NvFlowGridExportImportLayerMapping   NvFlowParticleSurfaceData   NvFlowShaderLinearParams   NvFlowVolumeRenderLMSParams   
NvFlowDeviceDesc   NvFlowGridExportLayeredView   NvFlowParticleSurfaceDesc   NvFlowShaderPointParams   NvFlowVolumeRenderMultiResParams   
NvFlowDeviceQueueDesc   NvFlowGridExportLayerView   NvFlowParticleSurfaceEmitParams   NvFlowShapeDesc   NvFlowVolumeRenderParams   
NvFlowDeviceQueueStatus   NvFlowGridExportSimpleShape   NvFlowParticleSurfaceParams   NvFlowShapeDescBox   NvFlowVolumeRenderViewport   
NvFlowDim   NvFlowGridImportDesc   NvFlowQueryTime   NvFlowShapeDescCapsule   NvFlowVolumeShadowDebugRenderParams   
NvFlowDynamicDescriptorHeapD3D12   NvFlowGridImportHandle   NvFlowRenderMaterialHandle   NvFlowShapeDescPlane   NvFlowVolumeShadowDesc   
NvFlowFloat3   NvFlowGridImportLayeredView   NvFlowRenderMaterialParams   NvFlowShapeDescSDF   NvFlowVolumeShadowParams   
NvFlowFloat4   NvFlowGridImportLayerView   NvFlowRenderMaterialPoolDesc   NvFlowShapeDescSphere   NvFlowVolumeShadowStats   
NvFlowFloat4x4   NvFlowGridImportParams   

N

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/doxygen.png b/docs/api/files/doxygen.png new file mode 100644 index 0000000..f0a274b Binary files /dev/null and b/docs/api/files/doxygen.png differ diff --git a/docs/api/files/files.html b/docs/api/files/files.html new file mode 100644 index 0000000..c0e4f50 --- /dev/null +++ b/docs/api/files/files.html @@ -0,0 +1,46 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: File Index + + + + + + + + +
+

File List

Here is a list of all files with brief descriptions: + + + + + + +
NvFlow.h [code]
NvFlowContext.h [code]
NvFlowContextD3D11.h [code]
NvFlowContextD3D12.h [code]
NvFlowShader.h [code]
NvFlowTypes.h [code]
+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/ftv2blank.png b/docs/api/files/ftv2blank.png new file mode 100644 index 0000000..493c3c0 Binary files /dev/null and b/docs/api/files/ftv2blank.png differ diff --git a/docs/api/files/ftv2doc.png b/docs/api/files/ftv2doc.png new file mode 100644 index 0000000..f72999f Binary files /dev/null and b/docs/api/files/ftv2doc.png differ diff --git a/docs/api/files/ftv2folderclosed.png b/docs/api/files/ftv2folderclosed.png new file mode 100644 index 0000000..d6d0634 Binary files /dev/null and b/docs/api/files/ftv2folderclosed.png differ diff --git a/docs/api/files/ftv2folderopen.png b/docs/api/files/ftv2folderopen.png new file mode 100644 index 0000000..bbe2c91 Binary files /dev/null and b/docs/api/files/ftv2folderopen.png differ diff --git a/docs/api/files/ftv2lastnode.png b/docs/api/files/ftv2lastnode.png new file mode 100644 index 0000000..e7b9ba9 Binary files /dev/null and b/docs/api/files/ftv2lastnode.png differ diff --git a/docs/api/files/ftv2link.png b/docs/api/files/ftv2link.png new file mode 100644 index 0000000..14f3fed Binary files /dev/null and b/docs/api/files/ftv2link.png differ diff --git a/docs/api/files/ftv2mlastnode.png b/docs/api/files/ftv2mlastnode.png new file mode 100644 index 0000000..09ceb6a Binary files /dev/null and b/docs/api/files/ftv2mlastnode.png differ diff --git a/docs/api/files/ftv2mnode.png b/docs/api/files/ftv2mnode.png new file mode 100644 index 0000000..3254c05 Binary files /dev/null and b/docs/api/files/ftv2mnode.png differ diff --git a/docs/api/files/ftv2node.png b/docs/api/files/ftv2node.png new file mode 100644 index 0000000..c9f06a5 Binary files /dev/null and b/docs/api/files/ftv2node.png differ diff --git a/docs/api/files/ftv2plastnode.png b/docs/api/files/ftv2plastnode.png new file mode 100644 index 0000000..0b07e00 Binary files /dev/null and b/docs/api/files/ftv2plastnode.png differ diff --git a/docs/api/files/ftv2pnode.png b/docs/api/files/ftv2pnode.png new file mode 100644 index 0000000..2001b79 Binary files /dev/null and b/docs/api/files/ftv2pnode.png differ diff --git a/docs/api/files/ftv2vertline.png b/docs/api/files/ftv2vertline.png new file mode 100644 index 0000000..b330f3a Binary files /dev/null and b/docs/api/files/ftv2vertline.png differ diff --git a/docs/api/files/functions.html b/docs/api/files/functions.html new file mode 100644 index 0000000..68bf1d9 --- /dev/null +++ b/docs/api/files/functions.html @@ -0,0 +1,90 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- a -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x62.html b/docs/api/files/functions_0x62.html new file mode 100644 index 0000000..204e1d0 --- /dev/null +++ b/docs/api/files/functions_0x62.html @@ -0,0 +1,105 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- b -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x63.html b/docs/api/files/functions_0x63.html new file mode 100644 index 0000000..9fe66a6 --- /dev/null +++ b/docs/api/files/functions_0x63.html @@ -0,0 +1,123 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- c -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x64.html b/docs/api/files/functions_0x64.html new file mode 100644 index 0000000..88e8287 --- /dev/null +++ b/docs/api/files/functions_0x64.html @@ -0,0 +1,129 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- d -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x65.html b/docs/api/files/functions_0x65.html new file mode 100644 index 0000000..5d09d98 --- /dev/null +++ b/docs/api/files/functions_0x65.html @@ -0,0 +1,77 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- e -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x66.html b/docs/api/files/functions_0x66.html new file mode 100644 index 0000000..8f9f527 --- /dev/null +++ b/docs/api/files/functions_0x66.html @@ -0,0 +1,91 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- f -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x67.html b/docs/api/files/functions_0x67.html new file mode 100644 index 0000000..9f0326c --- /dev/null +++ b/docs/api/files/functions_0x67.html @@ -0,0 +1,109 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- g -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x68.html b/docs/api/files/functions_0x68.html new file mode 100644 index 0000000..8b39b9c --- /dev/null +++ b/docs/api/files/functions_0x68.html @@ -0,0 +1,79 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- h -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x69.html b/docs/api/files/functions_0x69.html new file mode 100644 index 0000000..15e7059 --- /dev/null +++ b/docs/api/files/functions_0x69.html @@ -0,0 +1,91 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- i -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x6c.html b/docs/api/files/functions_0x6c.html new file mode 100644 index 0000000..4ddc432 --- /dev/null +++ b/docs/api/files/functions_0x6c.html @@ -0,0 +1,94 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- l -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x6d.html b/docs/api/files/functions_0x6d.html new file mode 100644 index 0000000..6d8af90 --- /dev/null +++ b/docs/api/files/functions_0x6d.html @@ -0,0 +1,131 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- m -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x6e.html b/docs/api/files/functions_0x6e.html new file mode 100644 index 0000000..47bd665 --- /dev/null +++ b/docs/api/files/functions_0x6e.html @@ -0,0 +1,111 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- n -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x6f.html b/docs/api/files/functions_0x6f.html new file mode 100644 index 0000000..ed65485 --- /dev/null +++ b/docs/api/files/functions_0x6f.html @@ -0,0 +1,72 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- o -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x70.html b/docs/api/files/functions_0x70.html new file mode 100644 index 0000000..e9cf601 --- /dev/null +++ b/docs/api/files/functions_0x70.html @@ -0,0 +1,100 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- p -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x71.html b/docs/api/files/functions_0x71.html new file mode 100644 index 0000000..77f82af --- /dev/null +++ b/docs/api/files/functions_0x71.html @@ -0,0 +1,72 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- q -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x72.html b/docs/api/files/functions_0x72.html new file mode 100644 index 0000000..f6f3be5 --- /dev/null +++ b/docs/api/files/functions_0x72.html @@ -0,0 +1,116 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- r -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x73.html b/docs/api/files/functions_0x73.html new file mode 100644 index 0000000..f892059 --- /dev/null +++ b/docs/api/files/functions_0x73.html @@ -0,0 +1,149 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- s -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x74.html b/docs/api/files/functions_0x74.html new file mode 100644 index 0000000..3d3025a --- /dev/null +++ b/docs/api/files/functions_0x74.html @@ -0,0 +1,83 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- t -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x75.html b/docs/api/files/functions_0x75.html new file mode 100644 index 0000000..8c0f28b --- /dev/null +++ b/docs/api/files/functions_0x75.html @@ -0,0 +1,81 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- u -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x76.html b/docs/api/files/functions_0x76.html new file mode 100644 index 0000000..e8986ee --- /dev/null +++ b/docs/api/files/functions_0x76.html @@ -0,0 +1,109 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- v -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x77.html b/docs/api/files/functions_0x77.html new file mode 100644 index 0000000..a85167e --- /dev/null +++ b/docs/api/files/functions_0x77.html @@ -0,0 +1,84 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- w -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x78.html b/docs/api/files/functions_0x78.html new file mode 100644 index 0000000..04d105a --- /dev/null +++ b/docs/api/files/functions_0x78.html @@ -0,0 +1,78 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- x -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x79.html b/docs/api/files/functions_0x79.html new file mode 100644 index 0000000..f9bb345 --- /dev/null +++ b/docs/api/files/functions_0x79.html @@ -0,0 +1,78 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- y -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_0x7a.html b/docs/api/files/functions_0x7a.html new file mode 100644 index 0000000..dd48daa --- /dev/null +++ b/docs/api/files/functions_0x7a.html @@ -0,0 +1,77 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: +

+

- z -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars.html b/docs/api/files/functions_vars.html new file mode 100644 index 0000000..a1a16d0 --- /dev/null +++ b/docs/api/files/functions_vars.html @@ -0,0 +1,90 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- a -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x62.html b/docs/api/files/functions_vars_0x62.html new file mode 100644 index 0000000..5cceaac --- /dev/null +++ b/docs/api/files/functions_vars_0x62.html @@ -0,0 +1,105 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- b -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x63.html b/docs/api/files/functions_vars_0x63.html new file mode 100644 index 0000000..0857af3 --- /dev/null +++ b/docs/api/files/functions_vars_0x63.html @@ -0,0 +1,123 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- c -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x64.html b/docs/api/files/functions_vars_0x64.html new file mode 100644 index 0000000..07bcf3d --- /dev/null +++ b/docs/api/files/functions_vars_0x64.html @@ -0,0 +1,129 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- d -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x65.html b/docs/api/files/functions_vars_0x65.html new file mode 100644 index 0000000..6a9c243 --- /dev/null +++ b/docs/api/files/functions_vars_0x65.html @@ -0,0 +1,77 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- e -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x66.html b/docs/api/files/functions_vars_0x66.html new file mode 100644 index 0000000..0813d66 --- /dev/null +++ b/docs/api/files/functions_vars_0x66.html @@ -0,0 +1,91 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- f -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x67.html b/docs/api/files/functions_vars_0x67.html new file mode 100644 index 0000000..96a2264 --- /dev/null +++ b/docs/api/files/functions_vars_0x67.html @@ -0,0 +1,109 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- g -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x68.html b/docs/api/files/functions_vars_0x68.html new file mode 100644 index 0000000..0c1f63a --- /dev/null +++ b/docs/api/files/functions_vars_0x68.html @@ -0,0 +1,79 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- h -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x69.html b/docs/api/files/functions_vars_0x69.html new file mode 100644 index 0000000..0dc673e --- /dev/null +++ b/docs/api/files/functions_vars_0x69.html @@ -0,0 +1,91 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- i -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x6c.html b/docs/api/files/functions_vars_0x6c.html new file mode 100644 index 0000000..ff89ced --- /dev/null +++ b/docs/api/files/functions_vars_0x6c.html @@ -0,0 +1,94 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- l -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x6d.html b/docs/api/files/functions_vars_0x6d.html new file mode 100644 index 0000000..955e278 --- /dev/null +++ b/docs/api/files/functions_vars_0x6d.html @@ -0,0 +1,131 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- m -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x6e.html b/docs/api/files/functions_vars_0x6e.html new file mode 100644 index 0000000..9e6c8e3 --- /dev/null +++ b/docs/api/files/functions_vars_0x6e.html @@ -0,0 +1,111 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- n -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x6f.html b/docs/api/files/functions_vars_0x6f.html new file mode 100644 index 0000000..c9b722c --- /dev/null +++ b/docs/api/files/functions_vars_0x6f.html @@ -0,0 +1,72 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- o -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x70.html b/docs/api/files/functions_vars_0x70.html new file mode 100644 index 0000000..19eeded --- /dev/null +++ b/docs/api/files/functions_vars_0x70.html @@ -0,0 +1,100 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- p -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x71.html b/docs/api/files/functions_vars_0x71.html new file mode 100644 index 0000000..f149d60 --- /dev/null +++ b/docs/api/files/functions_vars_0x71.html @@ -0,0 +1,72 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- q -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x72.html b/docs/api/files/functions_vars_0x72.html new file mode 100644 index 0000000..2f115bb --- /dev/null +++ b/docs/api/files/functions_vars_0x72.html @@ -0,0 +1,116 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- r -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x73.html b/docs/api/files/functions_vars_0x73.html new file mode 100644 index 0000000..7e2c52d --- /dev/null +++ b/docs/api/files/functions_vars_0x73.html @@ -0,0 +1,149 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- s -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x74.html b/docs/api/files/functions_vars_0x74.html new file mode 100644 index 0000000..070f6d0 --- /dev/null +++ b/docs/api/files/functions_vars_0x74.html @@ -0,0 +1,83 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- t -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x75.html b/docs/api/files/functions_vars_0x75.html new file mode 100644 index 0000000..c456d75 --- /dev/null +++ b/docs/api/files/functions_vars_0x75.html @@ -0,0 +1,81 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- u -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x76.html b/docs/api/files/functions_vars_0x76.html new file mode 100644 index 0000000..d9b0c0a --- /dev/null +++ b/docs/api/files/functions_vars_0x76.html @@ -0,0 +1,109 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- v -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x77.html b/docs/api/files/functions_vars_0x77.html new file mode 100644 index 0000000..1367d50 --- /dev/null +++ b/docs/api/files/functions_vars_0x77.html @@ -0,0 +1,84 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- w -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x78.html b/docs/api/files/functions_vars_0x78.html new file mode 100644 index 0000000..6cb14cb --- /dev/null +++ b/docs/api/files/functions_vars_0x78.html @@ -0,0 +1,78 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- x -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x79.html b/docs/api/files/functions_vars_0x79.html new file mode 100644 index 0000000..df62968 --- /dev/null +++ b/docs/api/files/functions_vars_0x79.html @@ -0,0 +1,78 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- y -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/functions_vars_0x7a.html b/docs/api/files/functions_vars_0x7a.html new file mode 100644 index 0000000..c9023ee --- /dev/null +++ b/docs/api/files/functions_vars_0x7a.html @@ -0,0 +1,77 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields - Variables + + + + + + + + +
+  +

+

- z -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/globals.html b/docs/api/files/globals.html new file mode 100644 index 0000000..05fa982 --- /dev/null +++ b/docs/api/files/globals.html @@ -0,0 +1,218 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to: +

+

- e -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/globals_0x6e.html b/docs/api/files/globals_0x6e.html new file mode 100644 index 0000000..9c0d75b --- /dev/null +++ b/docs/api/files/globals_0x6e.html @@ -0,0 +1,368 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to: +

+

- n -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/globals_defs.html b/docs/api/files/globals_defs.html new file mode 100644 index 0000000..d6f75c0 --- /dev/null +++ b/docs/api/files/globals_defs.html @@ -0,0 +1,56 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+  +

+

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/globals_enum.html b/docs/api/files/globals_enum.html new file mode 100644 index 0000000..8273c6f --- /dev/null +++ b/docs/api/files/globals_enum.html @@ -0,0 +1,84 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+  +

+

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/globals_eval.html b/docs/api/files/globals_eval.html new file mode 100644 index 0000000..b730e43 --- /dev/null +++ b/docs/api/files/globals_eval.html @@ -0,0 +1,217 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+  +

+

- e -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/globals_func.html b/docs/api/files/globals_func.html new file mode 100644 index 0000000..1812441 --- /dev/null +++ b/docs/api/files/globals_func.html @@ -0,0 +1,321 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+  +

+

- n -

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/globals_type.html b/docs/api/files/globals_type.html new file mode 100644 index 0000000..1b50d2c --- /dev/null +++ b/docs/api/files/globals_type.html @@ -0,0 +1,62 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Data Fields + + + + + + + + +
+  +

+

+
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_context.html b/docs/api/files/group___nv_flow_context.html new file mode 100644 index 0000000..23daddd --- /dev/null +++ b/docs/api/files/group___nv_flow_context.html @@ -0,0 +1,411 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowContext + + + + + + + + +
+

NvFlowContext

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowShaderLinearParams
 Parameters for shaders using the linear format (linear interpolation). More...
struct  NvFlowShaderPointParams
 Parameters for shaders using the point format (no linear interpolation). More...

Functions

bool NvFlowContextFlushRequestPop (NvFlowContext *context)
void NvFlowContextFlushRequestPush (NvFlowContext *context)
NvFlowContextAPI NvFlowContextGetContextType (NvFlowContext *context)
void NvFlowContextPop (NvFlowContext *context)
void NvFlowContextProcessFenceSignal (NvFlowContext *context)
void NvFlowContextProcessFenceWait (NvFlowContext *context)
void NvFlowContextPush (NvFlowContext *context)
NvFlowUint NvFlowDeferredRelease (float timeoutMS)
void NvFlowReleaseContext (NvFlowContext *context)
void NvFlowReleaseDepthStencilView (NvFlowDepthStencilView *view)
void NvFlowReleaseRenderTargetView (NvFlowRenderTargetView *view)
void NvFlowSetFreeFunc (void(*free)(void *ptr))
void NvFlowSetMallocFunc (void *(*malloc)(size_t size))
+

Function Documentation

+ +
+
+ + + + + + + + + +
bool NvFlowContextFlushRequestPop (NvFlowContext *  context  ) 
+
+
+ +

+Pop any pending requests for the Flow context to flush to queue, resets the request state

+

Parameters:
+ + +
[in] context The Flow context to check for requests on.
+
+
Returns:
true if a flush is requested
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowContextFlushRequestPush (NvFlowContext *  context  ) 
+
+
+ +

+Push a request for the Flow context to request a flush to queue

+

Parameters:
+ + +
[in] context The Flow context to make the request on.
+
+ +
+

+ +

+
+ + + + + + + + + +
NvFlowContextAPI NvFlowContextGetContextType (NvFlowContext *  context  ) 
+
+
+ +

+Get the API type of the current context

+

Parameters:
+ + +
[in] context The Flow context to get the type of.
+
+
Returns:
context The Flow context to be released.
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowContextPop (NvFlowContext *  context  ) 
+
+
+ +

+Restores graphics/compute pipeline state pushed by NvFlowContextPush.

+

Parameters:
+ + +
[in] context The Flow context to restore.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowContextProcessFenceSignal (NvFlowContext *  context  ) 
+
+
+ +

+Process pending GPU fence signals, on deviceQueue associated with this context

+

Parameters:
+ + +
[in] context The Flow context to submit fence signals on.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowContextProcessFenceWait (NvFlowContext *  context  ) 
+
+
+ +

+Process pending GPU wait on fence, on deviceQueue associated with this context

+

Parameters:
+ + +
[in] context The Flow context to submit fence waits on.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowContextPush (NvFlowContext *  context  ) 
+
+
+ +

+Pushes graphics/compute pipeline state for later restoration by NvFlowContextPop.

+

Parameters:
+ + +
[in] context The Flow context to push.
+
+ +
+

+ +

+
+ + + + + + + + + +
NvFlowUint NvFlowDeferredRelease (float  timeoutMS  ) 
+
+
+ +

+Should be called before DLL unload, to ensure complete cleanup.

+

Parameters:
+ + +
[in] timeoutMS Wait timeout, in milliseconds
+
+
Returns:
The current number of active deferred release units.
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseContext (NvFlowContext *  context  ) 
+
+
+ +

+Releases a Flow context.

+

Parameters:
+ + +
[in] context The Flow context to be released.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseDepthStencilView (NvFlowDepthStencilView *  view  ) 
+
+
+ +

+Releases a Flow depth stencil view.

+

Parameters:
+ + +
[in] view The Flow depth stencil view to be released.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseRenderTargetView (NvFlowRenderTargetView *  view  ) 
+
+
+ +

+Releases a Flow render target view.

+

Parameters:
+ + +
[in] view The Flow render target view to be released.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowSetFreeFunc (void(*)(void *ptr)  free  ) 
+
+
+ +

+An optional callback to allow the application to control how Flow releases CPU memory.

+

Parameters:
+ + +
[in] free The free function for Flow to use.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowSetMallocFunc (void *(*)(size_t size)  malloc  ) 
+
+
+ +

+An optional callback to allow the application to control how Flow allocates CPU memory.

+

Parameters:
+ + +
[in] malloc The allocation function for Flow to use.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_context_d3_d11.html b/docs/api/files/group___nv_flow_context_d3_d11.html new file mode 100644 index 0000000..340e57d --- /dev/null +++ b/docs/api/files/group___nv_flow_context_d3_d11.html @@ -0,0 +1,421 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowContextD3D11 + + + + + + + + +
+

NvFlowContextD3D11

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowContextDescD3D11
struct  NvFlowDepthStencilViewDescD3D11
struct  NvFlowRenderTargetViewDescD3D11
struct  NvFlowResourceRWViewDescD3D11
struct  NvFlowResourceViewDescD3D11

Functions

NvFlowContext * NvFlowCreateContextD3D11 (NvFlowUint version, const NvFlowContextDescD3D11 *desc)
NvFlowDepthStencilView * NvFlowCreateDepthStencilViewD3D11 (NvFlowContext *context, const NvFlowDepthStencilViewDescD3D11 *desc)
NvFlowRenderTargetView * NvFlowCreateRenderTargetViewD3D11 (NvFlowContext *context, const NvFlowRenderTargetViewDescD3D11 *desc)
void NvFlowUpdateContextD3D11 (NvFlowContext *context, const NvFlowContextDescD3D11 *desc)
void NvFlowUpdateContextDescD3D11 (NvFlowContext *context, NvFlowContextDescD3D11 *desc)
void NvFlowUpdateDepthStencilViewD3D11 (NvFlowContext *context, NvFlowDepthStencilView *view, const NvFlowDepthStencilViewDescD3D11 *desc)
void NvFlowUpdateRenderTargetViewD3D11 (NvFlowContext *context, NvFlowRenderTargetView *view, const NvFlowRenderTargetViewDescD3D11 *desc)
void NvFlowUpdateResourceRWViewDescD3D11 (NvFlowContext *context, NvFlowResourceRW *resourceRW, NvFlowResourceRWViewDescD3D11 *desc)
void NvFlowUpdateResourceViewDescD3D11 (NvFlowContext *context, NvFlowResource *resource, NvFlowResourceViewDescD3D11 *desc)
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
NvFlowContext* NvFlowCreateContextD3D11 (NvFlowUint  version,
const NvFlowContextDescD3D11 *  desc 
)
+
+
+ +

+Creates a graphics/compute context for Flow.

+

Parameters:
+ + + +
[in] version Should be set by app to NV_FLOW_VERSION.
[in] desc A graphics-API dependent structure containing data needed for a FlowContext to interoperate with the app.
+
+
Returns:
The created Flow context.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
NvFlowDepthStencilView* NvFlowCreateDepthStencilViewD3D11 (NvFlowContext *  context,
const NvFlowDepthStencilViewDescD3D11 *  desc 
)
+
+
+ +

+Creates a Flow depth stencil view based on information provided by the application.

+

Parameters:
+ + + +
[in] context The Flow context to create and use the depth stencil view.
[in] desc The graphics API dependent description.
+
+
Returns:
The created Flow depth stencil view.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
NvFlowRenderTargetView* NvFlowCreateRenderTargetViewD3D11 (NvFlowContext *  context,
const NvFlowRenderTargetViewDescD3D11 *  desc 
)
+
+
+ +

+Creates a Flow render target view based on information provided by the application.

+

Parameters:
+ + + +
[in] context The Flow context to create and use the render target view.
[in] desc The graphics API dependent description.
+
+
Returns:
The created Flow render target view.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowUpdateContextD3D11 (NvFlowContext *  context,
const NvFlowContextDescD3D11 *  desc 
)
+
+
+ +

+Updates a Flow context with information provided by the application.

+

Parameters:
+ + + +
[in] context The Flow context to update.
[in] desc The graphics API dependent description.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowUpdateContextDescD3D11 (NvFlowContext *  context,
NvFlowContextDescD3D11 *  desc 
)
+
+
+ +

+Gets a Flow context description from a Flow context.

+

Parameters:
+ + + +
[in] context The Flow context.
[out] desc The graphics API dependent description.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowUpdateDepthStencilViewD3D11 (NvFlowContext *  context,
NvFlowDepthStencilView *  view,
const NvFlowDepthStencilViewDescD3D11 *  desc 
)
+
+
+ +

+Updates a Flow depth stencil view with information provided by the application.

+

Parameters:
+ + + + +
[in] context The Flow context used to create the depth stencil view.
[in] view The Flow depth stencil view to update.
[in] desc The graphics API dependent description.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowUpdateRenderTargetViewD3D11 (NvFlowContext *  context,
NvFlowRenderTargetView *  view,
const NvFlowRenderTargetViewDescD3D11 *  desc 
)
+
+
+ +

+Updates a Flow render target view with information provided by the application.

+

Parameters:
+ + + + +
[in] context The Flow context used to create the render target view.
[in] view The Flow render target view to update.
[in] desc The graphics API dependent description.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowUpdateResourceRWViewDescD3D11 (NvFlowContext *  context,
NvFlowResourceRW *  resourceRW,
NvFlowResourceRWViewDescD3D11 *  desc 
)
+
+
+ +

+Updates an application visible description with internal Flow resourceRW information.

+

Parameters:
+ + + + +
[in] context The Flow context that created the resourceRW.
[in] resourceRW The Flow resourceRW to describe.
[out] desc The graphics API dependent Flow resourceRW description.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowUpdateResourceViewDescD3D11 (NvFlowContext *  context,
NvFlowResource *  resource,
NvFlowResourceViewDescD3D11 *  desc 
)
+
+
+ +

+Updates an application visible description with internal Flow resource information.

+

Parameters:
+ + + + +
[in] context The Flow context that created the resource.
[in] resource The Flow resource to describe.
[out] desc The graphics API dependent Flow resource description.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_context_d3_d12.html b/docs/api/files/group___nv_flow_context_d3_d12.html new file mode 100644 index 0000000..4bdc042 --- /dev/null +++ b/docs/api/files/group___nv_flow_context_d3_d12.html @@ -0,0 +1,425 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowContextD3D12 + + + + + + + + +
+

NvFlowContextD3D12

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowContextDescD3D12
struct  NvFlowDepthStencilViewDescD3D12
struct  NvFlowDescriptorReserveHandleD3D12
struct  NvFlowDynamicDescriptorHeapD3D12
struct  NvFlowRenderTargetViewDescD3D12
struct  NvFlowResourceRWViewDescD3D12
struct  NvFlowResourceViewDescD3D12

Functions

NvFlowContext * NvFlowCreateContextD3D12 (NvFlowUint version, const NvFlowContextDescD3D12 *desc)
NvFlowDepthStencilView * NvFlowCreateDepthStencilViewD3D12 (NvFlowContext *context, const NvFlowDepthStencilViewDescD3D12 *desc)
NvFlowRenderTargetView * NvFlowCreateRenderTargetViewD3D12 (NvFlowContext *context, const NvFlowRenderTargetViewDescD3D12 *desc)
void NvFlowUpdateContextD3D12 (NvFlowContext *context, const NvFlowContextDescD3D12 *desc)
void NvFlowUpdateContextDescD3D12 (NvFlowContext *context, NvFlowContextDescD3D12 *desc)
void NvFlowUpdateDepthStencilViewD3D12 (NvFlowContext *context, NvFlowDepthStencilView *view, const NvFlowDepthStencilViewDescD3D12 *desc)
void NvFlowUpdateRenderTargetViewD3D12 (NvFlowContext *context, NvFlowRenderTargetView *view, const NvFlowRenderTargetViewDescD3D12 *desc)
void NvFlowUpdateResourceRWViewDescD3D12 (NvFlowContext *context, NvFlowResourceRW *resourceRW, NvFlowResourceRWViewDescD3D12 *desc)
void NvFlowUpdateResourceViewDescD3D12 (NvFlowContext *context, NvFlowResource *resource, NvFlowResourceViewDescD3D12 *desc)
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
NvFlowContext* NvFlowCreateContextD3D12 (NvFlowUint  version,
const NvFlowContextDescD3D12 *  desc 
)
+
+
+ +

+Creates a graphics/compute context for Flow.

+

Parameters:
+ + + +
[in] version Should be set by app to NV_FLOW_VERSION.
[in] desc A graphics-API dependent structure containing data needed for a FlowContext to interoperate with the app.
+
+
Returns:
The created Flow context.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
NvFlowDepthStencilView* NvFlowCreateDepthStencilViewD3D12 (NvFlowContext *  context,
const NvFlowDepthStencilViewDescD3D12 *  desc 
)
+
+
+ +

+Creates a Flow depth stencil view based on information provided by the application.

+

Parameters:
+ + + +
[in] context The Flow context to create and use the depth stencil view.
[in] desc The graphics API dependent description.
+
+
Returns:
The created Flow depth stencil view.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
NvFlowRenderTargetView* NvFlowCreateRenderTargetViewD3D12 (NvFlowContext *  context,
const NvFlowRenderTargetViewDescD3D12 *  desc 
)
+
+
+ +

+Creates a Flow render target view based on information provided by the application.

+

Parameters:
+ + + +
[in] context The Flow context to create and use the render target view.
[in] desc The graphics API dependent description.
+
+
Returns:
The created Flow render target view.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowUpdateContextD3D12 (NvFlowContext *  context,
const NvFlowContextDescD3D12 *  desc 
)
+
+
+ +

+Updates a Flow context with information provided by the application.

+

Parameters:
+ + + +
[in] context The Flow context to update.
[in] desc The graphics API dependent description.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowUpdateContextDescD3D12 (NvFlowContext *  context,
NvFlowContextDescD3D12 *  desc 
)
+
+
+ +

+Gets a Flow context description from a Flow context.

+

Parameters:
+ + + +
[in] context The Flow context.
[out] desc The graphics API dependent description.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowUpdateDepthStencilViewD3D12 (NvFlowContext *  context,
NvFlowDepthStencilView *  view,
const NvFlowDepthStencilViewDescD3D12 *  desc 
)
+
+
+ +

+Updates a Flow depth stencil view with information provided by the application.

+

Parameters:
+ + + + +
[in] context The Flow context used to create the depth stencil view.
[in] view The Flow depth stencil view to update.
[in] desc The graphics API dependent description.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowUpdateRenderTargetViewD3D12 (NvFlowContext *  context,
NvFlowRenderTargetView *  view,
const NvFlowRenderTargetViewDescD3D12 *  desc 
)
+
+
+ +

+Updates a Flow render target view with information provided by the application.

+

Parameters:
+ + + + +
[in] context The Flow context used to create the render target view.
[in] view The Flow render target view to update.
[in] desc The graphics API dependent description.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowUpdateResourceRWViewDescD3D12 (NvFlowContext *  context,
NvFlowResourceRW *  resourceRW,
NvFlowResourceRWViewDescD3D12 *  desc 
)
+
+
+ +

+Updates an application visible description with internal Flow resourceRW information.

+

Parameters:
+ + + + +
[in] context The Flow context that created the resourceRW.
[in] buffer The Flow resourceRW to describe.
[out] desc The graphics API dependent Flow resourceRW description.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowUpdateResourceViewDescD3D12 (NvFlowContext *  context,
NvFlowResource *  resource,
NvFlowResourceViewDescD3D12 *  desc 
)
+
+
+ +

+Updates an application visible description with internal Flow resource information.

+

Parameters:
+ + + + +
[in] context The Flow context that created the resource.
[in] resource The Flow resource to describe.
[out] desc The graphics API dependent Flow resource description.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_cross_section.html b/docs/api/files/group___nv_flow_cross_section.html new file mode 100644 index 0000000..4d72ae5 --- /dev/null +++ b/docs/api/files/group___nv_flow_cross_section.html @@ -0,0 +1,184 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowCrossSection + + + + + + + + +
+

NvFlowCrossSection

+ + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowCrossSectionDesc
 Description required to create cross section object. More...
struct  NvFlowCrossSectionParams
 Parameters needed to render cross section. More...

Functions

NvFlowCrossSection * NvFlowCreateCrossSection (NvFlowContext *context, const NvFlowCrossSectionDesc *desc)
void NvFlowCrossSectionParamsDefaults (NvFlowCrossSectionParams *params)
void NvFlowCrossSectionRender (NvFlowCrossSection *crossSection, NvFlowContext *context, const NvFlowCrossSectionParams *params)
void NvFlowReleaseCrossSection (NvFlowCrossSection *crossSection)
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
NvFlowCrossSection* NvFlowCreateCrossSection (NvFlowContext *  context,
const NvFlowCrossSectionDesc *  desc 
)
+
+
+ +

+Creates a cross section object.

+

Parameters:
+ + + +
[in] context The context for GPU resource allocation.
[in] desc Description for memory allocation.
+
+
Returns:
The created cross section object.
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowCrossSectionParamsDefaults (NvFlowCrossSectionParams *  params  ) 
+
+
+ +

+Allows the application to request default cross section parameters from Flow.

+

Parameters:
+ + +
[out] params The parameters for Flow to fill out.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowCrossSectionRender (NvFlowCrossSection *  crossSection,
NvFlowContext *  context,
const NvFlowCrossSectionParams *  params 
)
+
+
+ +

+Renders a cross section of a grid export.

+

Parameters:
+ + + + +
[in] crossSection The cross section object.
[in] context The context that allocated the cross section object.
[in] params Parameters for cross section rendering.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseCrossSection (NvFlowCrossSection *  crossSection  ) 
+
+
+ +

+Releases a cross section object.

+

Parameters:
+ + +
[in] crossSection The cross section object to be released.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_device.html b/docs/api/files/group___nv_flow_device.html new file mode 100644 index 0000000..abc0eef --- /dev/null +++ b/docs/api/files/group___nv_flow_device.html @@ -0,0 +1,527 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowDevice + + + + + + + + +
+

NvFlowDevice

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowDeviceDesc
 Description required for creating a Flow device. More...
struct  NvFlowDeviceQueueDesc
 Description required for creating a Flow device queue. More...
struct  NvFlowDeviceQueueStatus
 Flow device queue status to allow app to throttle maximum queued work. More...

Enumerations

enum  NvFlowDeviceMode { eNvFlowDeviceModeProxy = 0, +eNvFlowDeviceModeUnique = 1 + }
 Device Type. More...
enum  NvFlowDeviceQueueType { eNvFlowDeviceQueueTypeGraphics = 0, +eNvFlowDeviceQueueTypeCompute = 1, +eNvFlowDeviceQueueTypeCopy = 2 + }
 Types of queues. More...

Functions

NvFlowDevice * NvFlowCreateDevice (NvFlowContext *renderContext, const NvFlowDeviceDesc *desc)
NvFlowDeviceQueue * NvFlowCreateDeviceQueue (NvFlowDevice *device, const NvFlowDeviceQueueDesc *desc)
bool NvFlowDedicatedDeviceAvailable (NvFlowContext *renderContext)
bool NvFlowDedicatedDeviceQueueAvailable (NvFlowContext *renderContext)
void NvFlowDeviceDescDefaults (NvFlowDeviceDesc *desc)
void NvFlowDeviceQueueConditionalFlush (NvFlowDeviceQueue *deviceQueue, NvFlowContext *context)
NvFlowContext * NvFlowDeviceQueueCreateContext (NvFlowDeviceQueue *deviceQueue)
void NvFlowDeviceQueueFlush (NvFlowDeviceQueue *deviceQueue, NvFlowContext *context)
void NvFlowDeviceQueueUpdateContext (NvFlowDeviceQueue *deviceQueue, NvFlowContext *context, NvFlowDeviceQueueStatus *status)
void NvFlowDeviceQueueWaitOnFence (NvFlowDeviceQueue *deviceQueue, NvFlowContext *context, NvFlowUint64 fenceValue)
void NvFlowReleaseDevice (NvFlowDevice *device)
void NvFlowReleaseDeviceQueue (NvFlowDeviceQueue *deviceQueue)
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum NvFlowDeviceMode
+
+
+ +

+Device Type. +

+

Enumerator:
+ + + +
eNvFlowDeviceModeProxy  +Exposes renderContext device.
eNvFlowDeviceModeUnique  +Generates unique device, not matching renderContext.
+
+ +
+

+ +

+
+ + + + +
enum NvFlowDeviceQueueType
+
+
+ +

+Types of queues. +

+

Enumerator:
+ + + + +
eNvFlowDeviceQueueTypeGraphics  +
eNvFlowDeviceQueueTypeCompute  +
eNvFlowDeviceQueueTypeCopy  +
+
+ +
+

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
NvFlowDevice* NvFlowCreateDevice (NvFlowContext *  renderContext,
const NvFlowDeviceDesc *  desc 
)
+
+
+ +

+Creates a Flow compute device.

+

Parameters:
+ + + +
[in] renderContext A context that maps to the application graphics GPU.
[in] desc Description that controls what GPU is selected.
+
+
Returns:
The created Flow compute device.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
NvFlowDeviceQueue* NvFlowCreateDeviceQueue (NvFlowDevice *  device,
const NvFlowDeviceQueueDesc *  desc 
)
+
+
+ +

+Creates a Flow device queue.

+

Parameters:
+ + + +
[in] device The device to create the queue on.
[in] desc Description that controls kind of device queue to create.
+
+
Returns:
The created Flow device queue.
+ +
+

+ +

+
+ + + + + + + + + +
bool NvFlowDedicatedDeviceAvailable (NvFlowContext *  renderContext  ) 
+
+
+ +

+Checks if a GPU is available that is not being used for application graphics work.

+

Parameters:
+ + +
[in] renderContext A context that maps to the application graphics GPU.
+
+
Returns:
Returns true if dedicated GPU is available.
+ +
+

+ +

+
+ + + + + + + + + +
bool NvFlowDedicatedDeviceQueueAvailable (NvFlowContext *  renderContext  ) 
+
+
+ +

+Checks if a GPU can support a dedicated queue

+

Parameters:
+ + +
[in] renderContext A context that maps to the application graphics GPU.
+
+
Returns:
Returns true if dedicated device queue is available.
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowDeviceDescDefaults (NvFlowDeviceDesc *  desc  ) 
+
+
+ +

+Allows the application to request a default Flow device description from Flow.

+

Parameters:
+ + +
[out] desc The description for Flow to fill out.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowDeviceQueueConditionalFlush (NvFlowDeviceQueue *  deviceQueue,
NvFlowContext *  context 
)
+
+
+ +

+Flushes all submitted work to the Flow deviceQueue if the context requests a flush.

+

Parameters:
+ + + +
[in] deviceQueue The Flow deviceQueue to conditionally flush.
[in] context The context to sync with the flush event.
+
+ +
+

+ +

+
+ + + + + + + + + +
NvFlowContext* NvFlowDeviceQueueCreateContext (NvFlowDeviceQueue *  deviceQueue  ) 
+
+
+ +

+Creates a context that uses a Flow device queue.

+

Parameters:
+ + +
[in] deviceQueue The Flow device queue to create the context against.
+
+
Returns:
The created context.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowDeviceQueueFlush (NvFlowDeviceQueue *  deviceQueue,
NvFlowContext *  context 
)
+
+
+ +

+Flushes all submitted work to the Flow deviceQueue. Must be called to submit work to queue.

+

Parameters:
+ + + +
[in] deviceQueue The Flow deviceQueue to flush.
[in] context The context to sync with the flush event
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowDeviceQueueUpdateContext (NvFlowDeviceQueue *  deviceQueue,
NvFlowContext *  context,
NvFlowDeviceQueueStatus *  status 
)
+
+
+ +

+Updates a context that uses a Flow device queue.

+

Parameters:
+ + + + +
[in] deviceQueue The Flow device queue the context was created against.
[in] context The context update.
[out] status Optional queue status to update, useful to detect if queue is overloaded.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowDeviceQueueWaitOnFence (NvFlowDeviceQueue *  deviceQueue,
NvFlowContext *  context,
NvFlowUint64  fenceValue 
)
+
+
+ +

+Blocks CPU until fenceValue is reached.

+

Parameters:
+ + + + +
[in] deviceQueue The Flow deviceQueue to flush.
[in] context The context to sync with the flush event.
[in] fenceValue The fence value to wait for.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseDevice (NvFlowDevice *  device  ) 
+
+
+ +

+Releases a Flow compute device.

+

Parameters:
+ + +
[in] device The Flow compute device to be released.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseDeviceQueue (NvFlowDeviceQueue *  deviceQueue  ) 
+
+
+ +

+Releases a Flow device queue.

+

Parameters:
+ + +
[in] deviceQueue The Flow device queue to be released.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_grid.html b/docs/api/files/group___nv_flow_grid.html new file mode 100644 index 0000000..04a6599 --- /dev/null +++ b/docs/api/files/group___nv_flow_grid.html @@ -0,0 +1,642 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGrid + + + + + + + + +
+

NvFlowGrid

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowGridDesc
 Description required to create a grid. More...
struct  NvFlowGridParams
 Parameters controlling grid behavior. More...
struct  NvFlowGridResetDesc
 Description required to reset a NvFlowGrid. More...
struct  NvFlowQueryTime
 CPU/GPU timing info. More...
struct  NvFlowSupport
 Description of feature support on the queried Flow context GPU. More...

Enumerations

enum  NvFlowGridDebugVisFlags {
+  eNvFlowGridDebugVisDisabled = 0x00, +eNvFlowGridDebugVisBlocks = 0x01, +eNvFlowGridDebugVisEmitBounds = 0x02, +eNvFlowGridDebugVisShapesSimple = 0x04, +
+  eNvFlowGridDebugVisCount +
+ }
 Flags to control grid debug visualization. More...
enum  NvFlowGridTextureChannel { eNvFlowGridTextureChannelVelocity = 0, +eNvFlowGridTextureChannelDensity = 1, +eNvFlowGridTextureChannelDensityCoarse = 2, +eNvFlowGridTextureChannelCount + }
 Grid texture channel, four components per channel. More...
enum  NvFlowMultiRes { eNvFlowMultiRes1x1x1 = 0, +eNvFlowMultiRes2x2x2 = 1 + }
 Enumeration used to describe density texture channel resolution relative to velocity resolution. More...

Functions

NvFlowGrid * NvFlowCreateGrid (NvFlowContext *context, const NvFlowGridDesc *desc)
void NvFlowGridDescDefaults (NvFlowGridDesc *desc)
NvFlowGridExport * NvFlowGridGetGridExport (NvFlowContext *context, NvFlowGrid *grid)
void NvFlowGridGPUMemUsage (NvFlowGrid *grid, NvFlowUint64 *numBytes)
void NvFlowGridParamsDefaults (NvFlowGridParams *params)
NvFlowResult NvFlowGridQuerySupport (NvFlowGrid *grid, NvFlowContext *context, NvFlowSupport *support)
NvFlowResult NvFlowGridQueryTime (NvFlowGrid *grid, NvFlowQueryTime *gpuTime, NvFlowQueryTime *cpuTime)
void NvFlowGridReset (NvFlowGrid *grid, const NvFlowGridResetDesc *desc)
void NvFlowGridResetDescDefaults (NvFlowGridResetDesc *desc)
void NvFlowGridSetParams (NvFlowGrid *grid, const NvFlowGridParams *params)
void NvFlowGridSetTargetLocation (NvFlowGrid *grid, NvFlowFloat3 targetLocation)
void NvFlowGridUpdate (NvFlowGrid *grid, NvFlowContext *context, float dt)
void NvFlowReleaseGrid (NvFlowGrid *grid)
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum NvFlowGridDebugVisFlags
+
+
+ +

+Flags to control grid debug visualization. +

+

Enumerator:
+ + + + + + +
eNvFlowGridDebugVisDisabled  +No debug visualization.
eNvFlowGridDebugVisBlocks  +Simulation block visualization, no overhead.
eNvFlowGridDebugVisEmitBounds  +Emitter bounds visualization, adds overhead.
eNvFlowGridDebugVisShapesSimple  +Visualize sphere/capsule/box shapes, adds overhead.
eNvFlowGridDebugVisCount  +
+
+ +
+

+ +

+
+ + + + +
enum NvFlowGridTextureChannel
+
+
+ +

+Grid texture channel, four components per channel. +

+

Enumerator:
+ + + + + +
eNvFlowGridTextureChannelVelocity  +
eNvFlowGridTextureChannelDensity  +
eNvFlowGridTextureChannelDensityCoarse  +
eNvFlowGridTextureChannelCount  +
+
+ +
+

+ +

+
+ + + + +
enum NvFlowMultiRes
+
+
+ +

+Enumeration used to describe density texture channel resolution relative to velocity resolution. +

+

Enumerator:
+ + + +
eNvFlowMultiRes1x1x1  +
eNvFlowMultiRes2x2x2  +
+
+ +
+

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
NvFlowGrid* NvFlowCreateGrid (NvFlowContext *  context,
const NvFlowGridDesc *  desc 
)
+
+
+ +

+Creates a grid.

+

Parameters:
+ + + +
[in] context The context to use to create the new grid.
[in] desc The grid description.
+
+
Returns:
The created grid.
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowGridDescDefaults (NvFlowGridDesc *  desc  ) 
+
+
+ +

+Allows the application to request a default grid description from Flow.

+

Parameters:
+ + +
[out] desc The description for Flow to fill out.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
NvFlowGridExport* NvFlowGridGetGridExport (NvFlowContext *  context,
NvFlowGrid *  grid 
)
+
+
+ +

+Get read interface to the grid simulation results

+

Parameters:
+ + + +
[in] context The context the grid was created with.
[in] grid The grid to read.
+
+
Returns:
Returns gridExport interface.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowGridGPUMemUsage (NvFlowGrid *  grid,
NvFlowUint64 *  numBytes 
)
+
+
+ +

+Queries simulation GPU memory usage.

+

Parameters:
+ + + +
[in] grid The grid to query for memory usage.
[out] numBytes GPU memory allocated in bytes.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowGridParamsDefaults (NvFlowGridParams *  params  ) 
+
+
+ +

+Allows the application to request default grid parameters from Flow.

+

Parameters:
+ + +
[out] params The parameters for Flow to fill out.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
NvFlowResult NvFlowGridQuerySupport (NvFlowGrid *  grid,
NvFlowContext *  context,
NvFlowSupport *  support 
)
+
+
+ +

+Queries support for features that depend on hardware/OS.

+

Parameters:
+ + + + +
[in] grid The grid to query for support.
[in] context The context the grid was created against.
[out] support Description of what is supported.
+
+
Returns:
Returns eNvFlowSuccess if information is available.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
NvFlowResult NvFlowGridQueryTime (NvFlowGrid *  grid,
NvFlowQueryTime *  gpuTime,
NvFlowQueryTime *  cpuTime 
)
+
+
+ +

+Queries simulation timing data.

+

Parameters:
+ + + + +
[in] grid The grid to query for timing.
[out] gpuTime Simulation overhead on GPU.
[out] cpuTime Simulation overhead on CPU.
+
+
Returns:
Returns eNvFlowSuccess if information is available.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowGridReset (NvFlowGrid *  grid,
const NvFlowGridResetDesc *  desc 
)
+
+
+ +

+Submits a request to reset a grid, preserving memory allocations

+

Parameters:
+ + + +
[in] grid The grid to reset.
[in] desc The grid reset description.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowGridResetDescDefaults (NvFlowGridResetDesc *  desc  ) 
+
+
+ +

+Allows the application to request a default grid reset description from Flow.

+

Parameters:
+ + +
[out] desc The description for Flow to fill out.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowGridSetParams (NvFlowGrid *  grid,
const NvFlowGridParams *  params 
)
+
+
+ +

+Sets grid simulation parameters, persistent over multiple grid updates.

+

Parameters:
+ + + +
[in] grid The grid to set parameters on.
[in] params The new parameter values.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowGridSetTargetLocation (NvFlowGrid *  grid,
NvFlowFloat3  targetLocation 
)
+
+
+ +

+Not fully supported yet. Allows the application to request the grid move to a new location.

+

Parameters:
+ + + +
[in] grid The grid to move.
[in] targetLocation The location the center of the grid should make a best effort attempt to reach.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowGridUpdate (NvFlowGrid *  grid,
NvFlowContext *  context,
float  dt 
)
+
+
+ +

+Steps the simulation dt forward in time.

+

Parameters:
+ + + + +
[in] grid The grid to update.
[in] context The context to perform the update.
[in] dt The time step, typically in seconds.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseGrid (NvFlowGrid *  grid  ) 
+
+
+ +

+Releases a grid.

+

Parameters:
+ + +
[in] grid The grid to be released.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_grid_emit.html b/docs/api/files/group___nv_flow_grid_emit.html new file mode 100644 index 0000000..04190c5 --- /dev/null +++ b/docs/api/files/group___nv_flow_grid_emit.html @@ -0,0 +1,220 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridEmit + + + + + + + + +
+

NvFlowGridEmit

+ + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowGridEmitParams
 Parameters for both emission and collision. More...

Enumerations

enum  NvFlowGridEmitMode {
+  eNvFlowGridEmitModeDefault = 0, +eNvFlowGridEmitModeDisableVelocity = 0x01, +eNvFlowGridEmitModeDisableDensity = 0x02, +eNvFlowGridEmitModeDisableAlloc = 0x04, +
+  eNvFlowGridEmitModeAllocShape = 0x08, +eNvFlowGridEmitModeAllocShapeOnly = 0x0F +
+ }
 Emitter modes. More...

Functions

void NvFlowGridEmit (NvFlowGrid *grid, const NvFlowShapeDesc *shapes, NvFlowUint numShapes, const NvFlowGridEmitParams *params, NvFlowUint numParams)
void NvFlowGridEmitParamsDefaults (NvFlowGridEmitParams *params)
void NvFlowGridUpdateEmitSDFs (NvFlowGrid *grid, NvFlowShapeSDF **sdfs, NvFlowUint numSdfs)
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum NvFlowGridEmitMode
+
+
+ +

+Emitter modes. +

+

Enumerator:
+ + + + + + + +
eNvFlowGridEmitModeDefault  +Emitter will influence velocity and density channels, optionally allocate based on bounds.
eNvFlowGridEmitModeDisableVelocity  +Flag to disable emitter interaction with velocity field.
eNvFlowGridEmitModeDisableDensity  +Flag to disable emitter interaction with density field.
eNvFlowGridEmitModeDisableAlloc  +Flag to disable emitter bound allocation.
eNvFlowGridEmitModeAllocShape  +Emitter will allocate using shape to drive allocation instead of only bounds.
eNvFlowGridEmitModeAllocShapeOnly  +Flags to configure for shape aware allocation only.
+
+ +
+

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowGridEmit (NvFlowGrid *  grid,
const NvFlowShapeDesc *  shapes,
NvFlowUint  numShapes,
const NvFlowGridEmitParams *  params,
NvFlowUint  numParams 
)
+
+
+ +

+Adds one or more emit events to be applied with the next grid update.

+

Parameters:
+ + + + + + +
[in] grid The Flow grid to apply the emit events.
[in] shapes Array of shape data referenced by emit params.
[in] numShapes Number of shapes in the array.
[in] params Array of emit event parameters.
[in] numParams Number of emit events in the array.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowGridEmitParamsDefaults (NvFlowGridEmitParams *  params  ) 
+
+
+ +

+Allows the application to request default emit parameters from Flow.

+

Parameters:
+ + +
[out] params The parameters for Flow to fill out.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowGridUpdateEmitSDFs (NvFlowGrid *  grid,
NvFlowShapeSDF **  sdfs,
NvFlowUint  numSdfs 
)
+
+
+ +

+Update internal array of SDFs that can be referenced by sdfOffset

+

Parameters:
+ + + + +
[in] grid The Flow grid to apply the emit events.
[in] sdfs Array of shape data referenced by emit params.
[in] numSdfs Number of shapes in the array.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_grid_emit_custom.html b/docs/api/files/group___nv_flow_grid_emit_custom.html new file mode 100644 index 0000000..c6bb500 --- /dev/null +++ b/docs/api/files/group___nv_flow_grid_emit_custom.html @@ -0,0 +1,225 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridEmitCustom + + + + + + + + +
+

NvFlowGridEmitCustom

+ + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowGridEmitCustomAllocParams
 Necessary parameters/resources for custom grid block allocation. More...
struct  NvFlowGridEmitCustomEmitLayerParams
 Necessary parameters/resources for custom emit operations. More...
struct  NvFlowGridEmitCustomEmitParams
 Handle for requesting per layer emitter data. More...

Typedefs

typedef void(* NvFlowGridEmitCustomAllocFunc )(void *userdata, const NvFlowGridEmitCustomAllocParams *params)
typedef void(* NvFlowGridEmitCustomEmitFunc )(void *userdata, NvFlowUint *dataFrontIdx, const NvFlowGridEmitCustomEmitParams *params)

Functions

void NvFlowGridEmitCustomGetLayerParams (const NvFlowGridEmitCustomEmitParams *emitParams, NvFlowUint layerIdx, NvFlowGridEmitCustomEmitLayerParams *emitLayerParams)
void NvFlowGridEmitCustomRegisterAllocFunc (NvFlowGrid *grid, NvFlowGridEmitCustomAllocFunc func, void *userdata)
void NvFlowGridEmitCustomRegisterEmitFunc (NvFlowGrid *grid, NvFlowGridTextureChannel channel, NvFlowGridEmitCustomEmitFunc func, void *userdata)
+

Typedef Documentation

+ +
+
+ + + + +
typedef void(* NvFlowGridEmitCustomAllocFunc)(void *userdata, const NvFlowGridEmitCustomAllocParams *params)
+
+
+ +

+ +

+

+ +

+
+ + + + +
typedef void(* NvFlowGridEmitCustomEmitFunc)(void *userdata, NvFlowUint *dataFrontIdx, const NvFlowGridEmitCustomEmitParams *params)
+
+
+ +

+ +

+

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowGridEmitCustomGetLayerParams (const NvFlowGridEmitCustomEmitParams *  emitParams,
NvFlowUint  layerIdx,
NvFlowGridEmitCustomEmitLayerParams *  emitLayerParams 
)
+
+
+ +

+Get per layer custom emit parameters, should only be called inside the custom emit callback.

+

Parameters:
+ + + + +
[in] emitParams The custom emit parameters.
[in] layerIdx The layerIdx to fetch, should be least than emitParams->numLayers.
[out] emitLayerParams Pointer to write parameters to.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowGridEmitCustomRegisterAllocFunc (NvFlowGrid *  grid,
NvFlowGridEmitCustomAllocFunc  func,
void *  userdata 
)
+
+
+ +

+Sets custom allocation callback.

+

Parameters:
+ + + + +
[in] grid The grid to use the callback.
[in] func The callback function.
[in] userdata Pointer to provide to the callback function during execution.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowGridEmitCustomRegisterEmitFunc (NvFlowGrid *  grid,
NvFlowGridTextureChannel  channel,
NvFlowGridEmitCustomEmitFunc  func,
void *  userdata 
)
+
+
+ +

+Sets custom emit callback for given simulation channel.

+

Parameters:
+ + + + + +
[in] grid The Flow grid to use the callback.
[in] channel The simulation channel for this callback.
[in] func The callback function.
[in] userdata Pointer to provide to the callback function during execution.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_grid_export.html b/docs/api/files/group___nv_flow_grid_export.html new file mode 100644 index 0000000..996508c --- /dev/null +++ b/docs/api/files/group___nv_flow_grid_export.html @@ -0,0 +1,226 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridExport + + + + + + + + +
+

NvFlowGridExport

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowGridExportDebugVisView
 Debug vis data. More...
struct  NvFlowGridExportHandle
 Texture channel export handle. More...
struct  NvFlowGridExportImportLayeredMapping
 Description applying to all exported layers. More...
struct  NvFlowGridExportImportLayerMapping
 Description of a single exported layer. More...
struct  NvFlowGridExportLayeredView
 Description applying to all exported layers. More...
struct  NvFlowGridExportLayerView
 Description of a single exported layer. More...
struct  NvFlowGridExportSimpleShape
 Data to visualize simple shape. More...

Functions

void NvFlowGridExportGetDebugVisView (NvFlowGridExport *gridExport, NvFlowGridExportDebugVisView *view)
NvFlowGridExportHandle NvFlowGridExportGetHandle (NvFlowGridExport *gridExport, NvFlowContext *context, NvFlowGridTextureChannel channel)
void NvFlowGridExportGetLayeredView (NvFlowGridExportHandle handle, NvFlowGridExportLayeredView *layeredView)
void NvFlowGridExportGetLayerView (NvFlowGridExportHandle handle, NvFlowUint layerIdx, NvFlowGridExportLayerView *layerView)
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
void NvFlowGridExportGetDebugVisView (NvFlowGridExport *  gridExport,
NvFlowGridExportDebugVisView *  view 
)
+
+
+ +

+Get export debug vis data.

+

Parameters:
+ + + +
[in] gridExport The grid export.
[out] view Destination for debug visualization view data.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
NvFlowGridExportHandle NvFlowGridExportGetHandle (NvFlowGridExport *  gridExport,
NvFlowContext *  context,
NvFlowGridTextureChannel  channel 
)
+
+
+ +

+Get export handle for the specified grid texture channel.

+

Parameters:
+ + + + +
[in] gridExport The grid export.
[in] context The context used to create the grid export.
[in] channel The grid texture channel to return a handle for.
+
+
Returns:
Returns export handle.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowGridExportGetLayeredView (NvFlowGridExportHandle  handle,
NvFlowGridExportLayeredView *  layeredView 
)
+
+
+ +

+Get layeredView data for specified exportHandle.

+

Parameters:
+ + + +
[in] handle The grid export handle.
[out] layeredView Destination for layeredView data.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowGridExportGetLayerView (NvFlowGridExportHandle  handle,
NvFlowUint  layerIdx,
NvFlowGridExportLayerView *  layerView 
)
+
+
+ +

+Get layerView data for specified exportHandle and layer index.

+

Parameters:
+ + + + +
[in] handle The grid export handle.
[in] layerIdx The layer index to return the layerView of.
[out] layerView Destination for layerView data.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_grid_import.html b/docs/api/files/group___nv_flow_grid_import.html new file mode 100644 index 0000000..eed7738 --- /dev/null +++ b/docs/api/files/group___nv_flow_grid_import.html @@ -0,0 +1,516 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridImport + + + + + + + + +
+

NvFlowGridImport

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowGridImportDesc
 Description required to create GridImport. More...
struct  NvFlowGridImportHandle
 Texture channel handle. More...
struct  NvFlowGridImportLayeredView
 Description applying to all imported layers. More...
struct  NvFlowGridImportLayerView
 Description of a single imported layer. More...
struct  NvFlowGridImportParams
 Parameters for grabbing import view. More...
struct  NvFlowGridImportStateCPUParams
 Parameters for grabbing import view. More...

Enumerations

enum  NvFlowGridImportMode { eNvFlowGridImportModePoint = 0, +eNvFlowGridImportModeLinear = 1 + }
 Grid import modes. More...

Functions

NvFlowGridImport * NvFlowCreateGridImport (NvFlowContext *context, const NvFlowGridImportDesc *desc)
NvFlowGridImportStateCPU * NvFlowCreateGridImportStateCPU (NvFlowGridImport *gridImport)
NvFlowGridExport * NvFlowGridImportGetGridExport (NvFlowGridImport *gridImport, NvFlowContext *context)
NvFlowGridImportHandle NvFlowGridImportGetHandle (NvFlowGridImport *gridImport, NvFlowContext *context, const NvFlowGridImportParams *params)
void NvFlowGridImportGetLayeredView (NvFlowGridImportHandle handle, NvFlowGridImportLayeredView *layeredView)
void NvFlowGridImportGetLayerView (NvFlowGridImportHandle handle, NvFlowUint layerIdx, NvFlowGridImportLayerView *layerView)
void NvFlowGridImportReleaseChannel (NvFlowGridImport *gridImport, NvFlowContext *context, NvFlowGridTextureChannel channel)
NvFlowGridImportHandle NvFlowGridImportStateCPUGetHandle (NvFlowGridImport *gridImport, NvFlowContext *context, const NvFlowGridImportStateCPUParams *params)
void NvFlowGridImportUpdateStateCPU (NvFlowGridImportStateCPU *stateCPU, NvFlowContext *context, NvFlowGridExport *gridExport)
void NvFlowReleaseGridImport (NvFlowGridImport *gridImport)
void NvFlowReleaseGridImportStateCPU (NvFlowGridImportStateCPU *stateCPU)
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum NvFlowGridImportMode
+
+
+ +

+Grid import modes. +

+

Enumerator:
+ + + +
eNvFlowGridImportModePoint  +Non redundant write target, conversion possible for linear sampling.
eNvFlowGridImportModeLinear  +Redundant write target, avoids conversion.
+
+ +
+

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
NvFlowGridImport* NvFlowCreateGridImport (NvFlowContext *  context,
const NvFlowGridImportDesc *  desc 
)
+
+
+ +

+Create a standalone grid import.

+

Parameters:
+ + + +
[in] context The context to use to create the new grid import.
[in] desc Description required to create grid import.
+
+
Returns:
Returns new grid import.
+ +
+

+ +

+
+ + + + + + + + + +
NvFlowGridImportStateCPU* NvFlowCreateGridImportStateCPU (NvFlowGridImport *  gridImport  ) 
+
+
+ +

+Create a grid import CPU state object.

+

Parameters:
+ + +
[in] gridImport The grid import to create the CPU state against.
+
+
Returns:
Returns new grid import CPU state.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
NvFlowGridExport* NvFlowGridImportGetGridExport (NvFlowGridImport *  gridImport,
NvFlowContext *  context 
)
+
+
+ +

+Get grid export for read access to grid import data.

+

Parameters:
+ + + +
[in] gridImport The grid import.
[in] context The context used to create the grid import.
+
+
Returns:
Returns grid export.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
NvFlowGridImportHandle NvFlowGridImportGetHandle (NvFlowGridImport *  gridImport,
NvFlowContext *  context,
const NvFlowGridImportParams *  params 
)
+
+
+ +

+Get import handle for the specified grid texture channel and import mode.

+

Parameters:
+ + + + +
[in] gridImport The grid import.
[in] context The context used to create the grid import.
[in] params Parameters for import handle.
+
+
Returns:
Returns import handle.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowGridImportGetLayeredView (NvFlowGridImportHandle  handle,
NvFlowGridImportLayeredView *  layeredView 
)
+
+
+ +

+Get layeredView data for specified importHandle.

+

Parameters:
+ + + +
[in] handle The grid import handle.
[out] layeredView Destination for layeredView data.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowGridImportGetLayerView (NvFlowGridImportHandle  handle,
NvFlowUint  layerIdx,
NvFlowGridImportLayerView *  layerView 
)
+
+
+ +

+Get layerView data for specified importHandle and layer index.

+

Parameters:
+ + + + +
[in] handle The grid import handle.
[in] layerIdx The layer index to return the layerView of.
[out] layerView Destination for layerView data.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowGridImportReleaseChannel (NvFlowGridImport *  gridImport,
NvFlowContext *  context,
NvFlowGridTextureChannel  channel 
)
+
+
+ +

+Release grid texture channel for grid import, allowing for memory recycle.

+

Parameters:
+ + + + +
[in] gridImport The grid import.
[in] context The context used to create the grid import.
[in] channel The grid texture channel to release.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
NvFlowGridImportHandle NvFlowGridImportStateCPUGetHandle (NvFlowGridImport *  gridImport,
NvFlowContext *  context,
const NvFlowGridImportStateCPUParams *  params 
)
+
+
+ +

+Get import handle, using previously captured CPU state to control configuration.

+

Parameters:
+ + + + +
[in] gridImport The grid import.
[in] context The context used to create the grid import.
[in] params Parameters for import handle.
+
+
Returns:
Returns import handle.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowGridImportUpdateStateCPU (NvFlowGridImportStateCPU *  stateCPU,
NvFlowContext *  context,
NvFlowGridExport *  gridExport 
)
+
+
+ +

+Capture CPU state from the provided grid export.

+

Parameters:
+ + + + +
[in] stateCPU The grid import CPU state to update.
[in] context The context used to create the grid export.
[in] gridExport The grid export to capture the CPU state of.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseGridImport (NvFlowGridImport *  gridImport  ) 
+
+
+ +

+Release a standalone grid import.

+

Parameters:
+ + +
[in] gridImport The grid import to release.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseGridImportStateCPU (NvFlowGridImportStateCPU *  stateCPU  ) 
+
+
+ +

+Release a grid import CPU state object.

+

Parameters:
+ + +
[in] stateCPU The grid import CPU state to release.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_grid_material.html b/docs/api/files/group___nv_flow_grid_material.html new file mode 100644 index 0000000..c3ef9eb --- /dev/null +++ b/docs/api/files/group___nv_flow_grid_material.html @@ -0,0 +1,270 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridMaterial + + + + + + + + +
+

NvFlowGridMaterial

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowGridMaterialHandle
 Handle provided by grid to reference materials. More...
struct  NvFlowGridMaterialParams
 Grid material parameters. More...
struct  NvFlowGridMaterialPerComponent
 Grid material per component parameters. More...

Enumerations

enum  NvFlowGridComponent {
+  eNvFlowGridComponentVelocity = 0, +eNvFlowGridComponentSmoke = 1, +eNvFlowGridComponentTemperature = 2, +eNvFlowGridComponentFuel = 3, +
+  eNvFlowGridNumComponents = 4 +
+ }
 Grid component IDs. More...

Functions

NvFlowGridMaterialHandle NvFlowGridCreateMaterial (NvFlowGrid *grid, const NvFlowGridMaterialParams *params)
NvFlowGridMaterialHandle NvFlowGridGetDefaultMaterial (NvFlowGrid *grid)
void NvFlowGridMaterialParamsDefaults (NvFlowGridMaterialParams *params)
void NvFlowGridReleaseMaterial (NvFlowGrid *grid, NvFlowGridMaterialHandle material)
void NvFlowGridSetMaterialParams (NvFlowGrid *grid, NvFlowGridMaterialHandle material, const NvFlowGridMaterialParams *params)
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum NvFlowGridComponent
+
+
+ +

+Grid component IDs. +

+

Enumerator:
+ + + + + + +
eNvFlowGridComponentVelocity  +
eNvFlowGridComponentSmoke  +
eNvFlowGridComponentTemperature  +
eNvFlowGridComponentFuel  +
eNvFlowGridNumComponents  +
+
+ +
+

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
NvFlowGridMaterialHandle NvFlowGridCreateMaterial (NvFlowGrid *  grid,
const NvFlowGridMaterialParams *  params 
)
+
+
+ +

+Creates new grid material, initializes to params.

+

Parameters:
+ + + +
[in] grid The Flow grid to set parameters on.
[in] params The new parameter values.
+
+
Returns:
Returns handle to newly create grid material.
+ +
+

+ +

+
+ + + + + + + + + +
NvFlowGridMaterialHandle NvFlowGridGetDefaultMaterial (NvFlowGrid *  grid  ) 
+
+
+ +

+Gets a handle to the default grid material.

+

Parameters:
+ + +
[in] grid The grid to return its default grid material.
+
+
Returns:
Returns default grid material for grid.
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowGridMaterialParamsDefaults (NvFlowGridMaterialParams *  params  ) 
+
+
+ +

+Allows the application to request default grid material parameters from Flow.

+

Parameters:
+ + +
[out] params The parameters for Flow to fill out.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowGridReleaseMaterial (NvFlowGrid *  grid,
NvFlowGridMaterialHandle  material 
)
+
+
+ +

+Release grid material

+

Parameters:
+ + + +
[in] grid The grid to set parameters on.
[in] material Handle to material to release.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowGridSetMaterialParams (NvFlowGrid *  grid,
NvFlowGridMaterialHandle  material,
const NvFlowGridMaterialParams *  params 
)
+
+
+ +

+Sets material parameters, persistent over multiple grid updates.

+

Parameters:
+ + + + +
[in] grid The grid to set parameters on.
[in] material Handle to material to update.
[in] params The new parameter values.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_grid_proxy.html b/docs/api/files/group___nv_flow_grid_proxy.html new file mode 100644 index 0000000..cdba262 --- /dev/null +++ b/docs/api/files/group___nv_flow_grid_proxy.html @@ -0,0 +1,258 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridProxy + + + + + + + + +
+

NvFlowGridProxy

+ + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowGridProxyDesc
 Parameters need to create a grid proxy. More...
struct  NvFlowGridProxyFlushParams
 Parameters need to create a multi-GPU proxy. More...

Enumerations

enum  NvFlowGridProxyType { eNvFlowGridProxyTypePassThrough = 0, +eNvFlowGridProxyTypeMultiGPU = 1, +eNvFlowGridProxyTypeInterQueue = 2 + }
 Proxy types. More...

Functions

NvFlowGridProxy * NvFlowCreateGridProxy (const NvFlowGridProxyDesc *desc)
void NvFlowGridProxyFlush (NvFlowGridProxy *proxy, const NvFlowGridProxyFlushParams *params)
NvFlowGridExport * NvFlowGridProxyGetGridExport (NvFlowGridProxy *proxy, NvFlowContext *renderContext)
void NvFlowGridProxyPush (NvFlowGridProxy *proxy, NvFlowGridExport *gridExport, const NvFlowGridProxyFlushParams *params)
void NvFlowReleaseGridProxy (NvFlowGridProxy *proxy)
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum NvFlowGridProxyType
+
+
+ +

+Proxy types. +

+

Enumerator:
+ + + + +
eNvFlowGridProxyTypePassThrough  +No operation, allows common code path for single versus multiple GPUs in the application.
eNvFlowGridProxyTypeMultiGPU  +Transports render data between GPUs.
eNvFlowGridProxyTypeInterQueue  +Versions grid export data for safe async compute.
+
+ +
+

+

Function Documentation

+ +
+
+ + + + + + + + + +
NvFlowGridProxy* NvFlowCreateGridProxy (const NvFlowGridProxyDesc *  desc  ) 
+
+
+ +

+Creates a grid proxy.

+

Parameters:
+ + +
[in] desc Description required to create grid proxy.
+
+
Returns:
The created grid proxy.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowGridProxyFlush (NvFlowGridProxy *  proxy,
const NvFlowGridProxyFlushParams *  params 
)
+
+
+ +

+Helps simulation results move faster between GPUs, should be called before each render.

+

Parameters:
+ + + +
[in] proxy The grid proxy to be flushed.
[in] params Parameters needed to flush the data.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
NvFlowGridExport* NvFlowGridProxyGetGridExport (NvFlowGridProxy *  proxy,
NvFlowContext *  renderContext 
)
+
+
+ +

+Returns the latest grid export available on the render GPU.

+

Parameters:
+ + + +
[in] proxy The grid proxy supplying the grid export.
[in] renderContext The context that will render the grid export.
+
+
Returns:
The latest grid export available from the proxy.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowGridProxyPush (NvFlowGridProxy *  proxy,
NvFlowGridExport *  gridExport,
const NvFlowGridProxyFlushParams *  params 
)
+
+
+ +

+Pushes simulation results to the proxy, should be updated after each simulation update.

+

Parameters:
+ + + + +
[in] proxy The grid proxy to be updated.
[in] gridExport The grid export with latest simulation results.
[in] params Parameters needed to flush the data.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseGridProxy (NvFlowGridProxy *  proxy  ) 
+
+
+ +

+Releases a grid proxy.

+

Parameters:
+ + +
[in] proxy The grid proxy to be released.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_particle_surface.html b/docs/api/files/group___nv_flow_particle_surface.html new file mode 100644 index 0000000..a295df9 --- /dev/null +++ b/docs/api/files/group___nv_flow_particle_surface.html @@ -0,0 +1,409 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowParticleSurface + + + + + + + + +
+

NvFlowParticleSurface

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowParticleSurfaceData
 Particle data. More...
struct  NvFlowParticleSurfaceDesc
 Description for creation. More...
struct  NvFlowParticleSurfaceEmitParams
 Parameter for surface emission. More...
struct  NvFlowParticleSurfaceParams
 Parameters for update. More...

Functions

NvFlowParticleSurface * NvFlowCreateParticleSurface (NvFlowContext *context, const NvFlowParticleSurfaceDesc *desc)
void NvFlowParticleSurfaceAllocFunc (NvFlowParticleSurface *surface, NvFlowContext *context, const NvFlowGridEmitCustomAllocParams *params)
NvFlowGridExport * NvFlowParticleSurfaceDebugGridExport (NvFlowParticleSurface *surface, NvFlowContext *context)
void NvFlowParticleSurfaceEmitDensityFunc (NvFlowParticleSurface *surface, NvFlowContext *context, NvFlowUint *dataFrontIdx, const NvFlowGridEmitCustomEmitParams *params, const NvFlowParticleSurfaceEmitParams *emitParams)
void NvFlowParticleSurfaceEmitVelocityFunc (NvFlowParticleSurface *surface, NvFlowContext *context, NvFlowUint *dataFrontIdx, const NvFlowGridEmitCustomEmitParams *params, const NvFlowParticleSurfaceEmitParams *emitParams)
void NvFlowParticleSurfaceUpdateParticles (NvFlowParticleSurface *surface, NvFlowContext *context, const NvFlowParticleSurfaceData *data)
void NvFlowParticleSurfaceUpdateSurface (NvFlowParticleSurface *surface, NvFlowContext *context, const NvFlowParticleSurfaceParams *params)
void NvFlowReleaseParticleSurface (NvFlowParticleSurface *surface)
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
NvFlowParticleSurface* NvFlowCreateParticleSurface (NvFlowContext *  context,
const NvFlowParticleSurfaceDesc *  desc 
)
+
+
+ +

+Create a particle surface object.

+

Parameters:
+ + + +
[in] context The context to use to create the new particle surface.
[in] desc Description required to create particle surface object.
+
+
Returns:
Returns created particle surface object.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowParticleSurfaceAllocFunc (NvFlowParticleSurface *  surface,
NvFlowContext *  context,
const NvFlowGridEmitCustomAllocParams *  params 
)
+
+
+ +

+Apply particle surface allocation to grid.

+

Parameters:
+ + + + +
[in] surface The particle surface object.
[in] context The context used to create the particle surface and the grid.
[in] params Parameters for grid custom allocation callback.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
NvFlowGridExport* NvFlowParticleSurfaceDebugGridExport (NvFlowParticleSurface *  surface,
NvFlowContext *  context 
)
+
+
+ +

+Get grid export that can be ray marched to visualize the generated particle surface/volume.

+

Parameters:
+ + + +
[in] surface The particle surface object.
[in] context The context used to create the particle surface.
+
+
Returns:
Returns the grid export.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowParticleSurfaceEmitDensityFunc (NvFlowParticleSurface *  surface,
NvFlowContext *  context,
NvFlowUint *  dataFrontIdx,
const NvFlowGridEmitCustomEmitParams *  params,
const NvFlowParticleSurfaceEmitParams *  emitParams 
)
+
+
+ +

+Apply particle surface emit operation to grid density texture channel.

+

Parameters:
+ + + + + + +
[in] surface The particle surface object.
[in] context The context used to create the particle surface and the grid.
[in] dataFrontIdx Pointer to front data index.
[in] params Parameters for grid custom emit callback.
[in] emitParams Parameters to control surface emit behavior.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowParticleSurfaceEmitVelocityFunc (NvFlowParticleSurface *  surface,
NvFlowContext *  context,
NvFlowUint *  dataFrontIdx,
const NvFlowGridEmitCustomEmitParams *  params,
const NvFlowParticleSurfaceEmitParams *  emitParams 
)
+
+
+ +

+Apply particle surface emit operation to grid velocity texture channel.

+

Parameters:
+ + + + + + +
[in] surface The particle surface object.
[in] context The context used to create the particle surface and the grid.
[in] dataFrontIdx Pointer to front data index.
[in] params Parameters for grid custom emit callback.
[in] emitParams Parameters to control surface emit behavior.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowParticleSurfaceUpdateParticles (NvFlowParticleSurface *  surface,
NvFlowContext *  context,
const NvFlowParticleSurfaceData *  data 
)
+
+
+ +

+Update particle data for particle surface.

+

Parameters:
+ + + + +
[in] surface The particle surface to update.
[in] context The context used to create the particle surface.
[in] data Particle data.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowParticleSurfaceUpdateSurface (NvFlowParticleSurface *  surface,
NvFlowContext *  context,
const NvFlowParticleSurfaceParams *  params 
)
+
+
+ +

+Generate surface using the latest particle data.

+

Parameters:
+ + + + +
[in] surface The particle surface to update.
[in] context The context used to create the particle surface.
[in] params Parameters for surface generation.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseParticleSurface (NvFlowParticleSurface *  surface  ) 
+
+
+ +

+Releases a particle surface object.

+

Parameters:
+ + +
[in] surface The particle surface object to be released.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_render_material.html b/docs/api/files/group___nv_flow_render_material.html new file mode 100644 index 0000000..f0890f6 --- /dev/null +++ b/docs/api/files/group___nv_flow_render_material.html @@ -0,0 +1,407 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowRenderMaterial + + + + + + + + +
+

NvFlowRenderMaterial

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowColorMapData
 Required information for writing to a CPU mapped color map. More...
struct  NvFlowRenderMaterialHandle
 A handle to a volume render material. More...
struct  NvFlowRenderMaterialParams
 Per material parameters for Flow grid rendering. More...
struct  NvFlowRenderMaterialPoolDesc
 Description necessary to create render material. More...

Enumerations

enum  NvFlowVolumeRenderMode {
+  eNvFlowVolumeRenderMode_colormap = 0, +eNvFlowVolumeRenderMode_raw = 1, +eNvFlowVolumeRenderMode_rainbow = 2, +eNvFlowVolumeRenderMode_debug = 3, +
+  eNvFlowVolumeRenderModeCount +
+ }
 Render modes. More...

Functions

NvFlowRenderMaterialHandle NvFlowCreateRenderMaterial (NvFlowContext *context, NvFlowRenderMaterialPool *pool, const NvFlowRenderMaterialParams *params)
NvFlowRenderMaterialPool * NvFlowCreateRenderMaterialPool (NvFlowContext *context, const NvFlowRenderMaterialPoolDesc *desc)
NvFlowRenderMaterialHandle NvFlowGetDefaultRenderMaterial (NvFlowRenderMaterialPool *pool)
void NvFlowReleaseRenderMaterial (NvFlowRenderMaterialHandle handle)
void NvFlowReleaseRenderMaterialPool (NvFlowRenderMaterialPool *pool)
NvFlowColorMapData NvFlowRenderMaterialColorMap (NvFlowContext *context, NvFlowRenderMaterialHandle handle)
void NvFlowRenderMaterialColorUnmap (NvFlowContext *context, NvFlowRenderMaterialHandle handle)
void NvFlowRenderMaterialParamsDefaults (NvFlowRenderMaterialParams *params)
void NvFlowRenderMaterialUpdate (NvFlowRenderMaterialHandle handle, const NvFlowRenderMaterialParams *params)
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum NvFlowVolumeRenderMode
+
+
+ +

+Render modes. +

+

Enumerator:
+ + + + + + +
eNvFlowVolumeRenderMode_colormap  +Uses color map defined in render material.
eNvFlowVolumeRenderMode_raw  +Treats sampled value as RGBA.
eNvFlowVolumeRenderMode_rainbow  +Visualizes single component with rainbow color, good for density visualization.
eNvFlowVolumeRenderMode_debug  +Visualizes xyz components with color, good for velocity visualization.
eNvFlowVolumeRenderModeCount  +
+
+ +
+

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
NvFlowRenderMaterialHandle NvFlowCreateRenderMaterial (NvFlowContext *  context,
NvFlowRenderMaterialPool *  pool,
const NvFlowRenderMaterialParams *  params 
)
+
+
+ +

+Create a render material.

+

Parameters:
+ + + + +
[in] context The context to use for GPU resource creation.
[in] pool The pool to create/own the material.
[in] params Material parameters.
+
+
Returns:
Returns a handle to the material.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
NvFlowRenderMaterialPool* NvFlowCreateRenderMaterialPool (NvFlowContext *  context,
const NvFlowRenderMaterialPoolDesc *  desc 
)
+
+
+ +

+Creates a render material pool object.

+

Parameters:
+ + + +
[in] context The context for GPU resource allocation.
[in] desc Description for memory allocation.
+
+
Returns:
The created volume render object.
+ +
+

+ +

+
+ + + + + + + + + +
NvFlowRenderMaterialHandle NvFlowGetDefaultRenderMaterial (NvFlowRenderMaterialPool *  pool  ) 
+
+
+ +

+Get the default render material.

+

Parameters:
+ + +
[in] pool The pool to create/own the material.
+
+
Returns:
Returns a handle to the default material.
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseRenderMaterial (NvFlowRenderMaterialHandle  handle  ) 
+
+
+ +

+Release a render material.

+

Parameters:
+ + +
[in] handle Handle to the material to release.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseRenderMaterialPool (NvFlowRenderMaterialPool *  pool  ) 
+
+
+ +

+Releases a volume render object.

+

Parameters:
+ + +
[in] pool The volume render object to be released.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
NvFlowColorMapData NvFlowRenderMaterialColorMap (NvFlowContext *  context,
NvFlowRenderMaterialHandle  handle 
)
+
+
+ +

+Map the color map associated with the material for write access.

+

Parameters:
+ + + +
[in] context The context to use for mapping.
[in] handle Handle to the material to map.
+
+
Returns:
Returns a pointer and range of CPU memory for write access.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowRenderMaterialColorUnmap (NvFlowContext *  context,
NvFlowRenderMaterialHandle  handle 
)
+
+
+ +

+Unmap the color map associated with the material.

+

Parameters:
+ + + +
[in] context The context to perform unmap.
[in] handle Handle to the material to unmap.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowRenderMaterialParamsDefaults (NvFlowRenderMaterialParams *  params  ) 
+
+
+ +

+Allows the application to request default volume render material parameters from Flow.

+

Parameters:
+ + +
[out] params The parameters for Flow to fill out.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowRenderMaterialUpdate (NvFlowRenderMaterialHandle  handle,
const NvFlowRenderMaterialParams *  params 
)
+
+
+ +

+Update a render material.

+

Parameters:
+ + + +
[in] handle Handle to the material to update.
[in] params Material parameters.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_s_d_f_generator.html b/docs/api/files/group___nv_flow_s_d_f_generator.html new file mode 100644 index 0000000..77d3ecd --- /dev/null +++ b/docs/api/files/group___nv_flow_s_d_f_generator.html @@ -0,0 +1,271 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowSDFGenerator + + + + + + + + +
+

NvFlowSDFGenerator

+ + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowSDFGenDesc
 Description required for creating a signed distance field generator. More...
struct  NvFlowSDFGenMeshParams
 Simple mesh description. More...

Functions

NvFlowSDFGen * NvFlowCreateSDFGen (NvFlowContext *context, const NvFlowSDFGenDesc *desc)
void NvFlowReleaseSDFGen (NvFlowSDFGen *sdfGen)
void NvFlowSDFGenReset (NvFlowSDFGen *sdfGen, NvFlowContext *context)
NvFlowTexture3D * NvFlowSDFGenShape (NvFlowSDFGen *sdfGen, NvFlowContext *context)
void NvFlowSDFGenUpdate (NvFlowSDFGen *sdfGen, NvFlowContext *context)
void NvFlowSDFGenVoxelize (NvFlowSDFGen *sdfGen, NvFlowContext *context, const NvFlowSDFGenMeshParams *params)
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
NvFlowSDFGen* NvFlowCreateSDFGen (NvFlowContext *  context,
const NvFlowSDFGenDesc *  desc 
)
+
+
+ +

+Creates a Flow signed distance field generator.

+

Parameters:
+ + + +
[in] context The context for GPU resource allocation.
[in] desc Description for memory allocation.
+
+
Returns:
The created signed distance field generator.
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseSDFGen (NvFlowSDFGen *  sdfGen  ) 
+
+
+ +

+Releases a signed distance field generator.

+

Parameters:
+ + +
[in] sdfGen The signed distance field generator to be released.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowSDFGenReset (NvFlowSDFGen *  sdfGen,
NvFlowContext *  context 
)
+
+
+ +

+Clears previous voxelization.

+

Parameters:
+ + + +
[in] sdfGen The signed distance field generator to test.
[in] context The context that created sdfGen.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
NvFlowTexture3D* NvFlowSDFGenShape (NvFlowSDFGen *  sdfGen,
NvFlowContext *  context 
)
+
+
+ +

+Provides access to signed distance field 3D Texture.

+

Parameters:
+ + + +
[in] sdfGen The signed distance field generator.
[in] context The context that created sdfGen.
+
+
Returns:
The 3D texture storing the latest signed distance field.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowSDFGenUpdate (NvFlowSDFGen *  sdfGen,
NvFlowContext *  context 
)
+
+
+ +

+Generates signed distance field from latest voxelization.

+

Parameters:
+ + + +
[in] sdfGen The signed distance field generator to update.
[in] context The context that created sdfGen.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowSDFGenVoxelize (NvFlowSDFGen *  sdfGen,
NvFlowContext *  context,
const NvFlowSDFGenMeshParams *  params 
)
+
+
+ +

+Voxelizes triangle mesh.

+

Parameters:
+ + + + +
[in] sdfGen The signed distance field generator to perform voxelization.
[in] context The context that created sdfGen.
[in] params Parameters, including triangle mesh data.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_shape.html b/docs/api/files/group___nv_flow_shape.html new file mode 100644 index 0000000..7d38520 --- /dev/null +++ b/docs/api/files/group___nv_flow_shape.html @@ -0,0 +1,317 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowShape + + + + + + + + +
+

NvFlowShape

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

union  NvFlowShapeDesc
 Shared type for shape descriptions. More...
struct  NvFlowShapeDescBox
 Description of a box. More...
struct  NvFlowShapeDescCapsule
 Description of a capsule. More...
struct  NvFlowShapeDescPlane
 Description of a plane. More...
struct  NvFlowShapeDescSDF
 Description of a signed distance field shape. More...
struct  NvFlowShapeDescSphere
 Desription of a sphere. More...
struct  NvFlowShapeSDFData
 Required information for writing to a CPU mapped signed distance field. More...
struct  NvFlowShapeSDFDesc
 Description required to create a signed distance field object. More...

Enumerations

enum  NvFlowShapeType {
+  eNvFlowShapeTypeSDF = 0, +eNvFlowShapeTypeSphere = 1, +eNvFlowShapeTypeBox = 2, +eNvFlowShapeTypeCapsule = 3, +
+  eNvFlowShapeTypePlane = 4 +
+ }
 Types of shapes for emit/collide behavior. More...

Functions

NvFlowShapeSDF * NvFlowCreateShapeSDF (NvFlowContext *context, const NvFlowShapeSDFDesc *desc)
NvFlowShapeSDF * NvFlowCreateShapeSDFFromTexture3D (NvFlowContext *context, NvFlowTexture3D *texture)
void NvFlowReleaseShapeSDF (NvFlowShapeSDF *shape)
void NvFlowShapeSDFDescDefaults (NvFlowShapeSDFDesc *desc)
NvFlowShapeSDFData NvFlowShapeSDFMap (NvFlowShapeSDF *shape, NvFlowContext *context)
void NvFlowShapeSDFUnmap (NvFlowShapeSDF *shape, NvFlowContext *context)
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum NvFlowShapeType
+
+
+ +

+Types of shapes for emit/collide behavior. +

+

Enumerator:
+ + + + + + +
eNvFlowShapeTypeSDF  +
eNvFlowShapeTypeSphere  +
eNvFlowShapeTypeBox  +
eNvFlowShapeTypeCapsule  +
eNvFlowShapeTypePlane  +
+
+ +
+

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
NvFlowShapeSDF* NvFlowCreateShapeSDF (NvFlowContext *  context,
const NvFlowShapeSDFDesc *  desc 
)
+
+
+ +

+Creates a signed distance field object with no initial data.

+

Parameters:
+ + + +
[in] context The context to use for creation.
[in] desc A description needed for memory allocation.
+
+
Returns:
The created signed distance field object.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
NvFlowShapeSDF* NvFlowCreateShapeSDFFromTexture3D (NvFlowContext *  context,
NvFlowTexture3D *  texture 
)
+
+
+ +

+Creates a signed distance field object with data from a 3D texture.

+

Parameters:
+ + + +
[in] context The context to use for creation.
[in] texture The 3D texture containing the signed distance field to use.
+
+
Returns:
The created signed distance field object.
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseShapeSDF (NvFlowShapeSDF *  shape  ) 
+
+
+ +

+Releases a signed distance field object.

+

Parameters:
+ + +
[in] shape The signed distance field to be released.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowShapeSDFDescDefaults (NvFlowShapeSDFDesc *  desc  ) 
+
+
+ +

+Allows the application to request a default signed distance field object description from Flow.

+

Parameters:
+ + +
[out] desc The description for Flow to fill out.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
NvFlowShapeSDFData NvFlowShapeSDFMap (NvFlowShapeSDF *  shape,
NvFlowContext *  context 
)
+
+
+ +

+Maps a signed distance field object for CPU write access.

+

Parameters:
+ + + +
[in] shape The signed distance field object to map.
[in] context The context used to create the Flow signed distance field.
+
+
Returns:
Returns the information needed to properly write to the mapped signed distance field object.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowShapeSDFUnmap (NvFlowShapeSDF *  shape,
NvFlowContext *  context 
)
+
+
+ +

+Unmaps a signed distance field object from CPU write access, uploads update field to GPU.

+

Parameters:
+ + + +
[in] shape The signed distance field object to unmap.
[in] context The context used to create the Flow signed distance field.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_volume_render.html b/docs/api/files/group___nv_flow_volume_render.html new file mode 100644 index 0000000..5a0c5a6 --- /dev/null +++ b/docs/api/files/group___nv_flow_volume_render.html @@ -0,0 +1,382 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowVolumeRender + + + + + + + + +
+

NvFlowVolumeRender

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowVolumeLightingParams
 Parameters for Flow grid lighting. More...
struct  NvFlowVolumeRenderDesc
 Description needed to a create a volume render object. More...
struct  NvFlowVolumeRenderLMSParams
 Parameters for VRWorks lens matched shading rendering. More...
struct  NvFlowVolumeRenderMultiResParams
 Parameters for VRWorks multires rendering. More...
struct  NvFlowVolumeRenderParams
 Parameters for Flow grid rendering. More...
struct  NvFlowVolumeRenderViewport
 Rendering viewport. More...

Enumerations

enum  NvFlowMultiResRayMarch {
+  eNvFlowMultiResRayMarchDisabled = 0, +eNvFlowMultiResRayMarch2x2 = 1, +eNvFlowMultiResRayMarch4x4 = 2, +eNvFlowMultiResRayMarch8x8 = 3, +
+  eNvFlowMultiResRayMarch16x16 = 4 +
+ }
 Multiple resolution options for offscreen ray march. More...
enum  NvFlowVolumeRenderDownsample { eNvFlowVolumeRenderDownsampleNone = 0, +eNvFlowVolumeRenderDownsample2x2 = 1 + }
 Downsample options for offscreen ray march. More...

Functions

NvFlowVolumeRender * NvFlowCreateVolumeRender (NvFlowContext *context, const NvFlowVolumeRenderDesc *desc)
void NvFlowReleaseVolumeRender (NvFlowVolumeRender *volumeRender)
void NvFlowVolumeRenderGridExport (NvFlowVolumeRender *volumeRender, NvFlowContext *context, NvFlowGridExport *gridExport, const NvFlowVolumeRenderParams *params)
NvFlowGridExport * NvFlowVolumeRenderLightGridExport (NvFlowVolumeRender *volumeRender, NvFlowContext *context, NvFlowGridExport *gridExport, const NvFlowVolumeLightingParams *params)
void NvFlowVolumeRenderParamsDefaults (NvFlowVolumeRenderParams *params)
void NvFlowVolumeRenderTexture3D (NvFlowVolumeRender *volumeRender, NvFlowContext *context, NvFlowTexture3D *density, const NvFlowVolumeRenderParams *params)
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum NvFlowMultiResRayMarch
+
+
+ +

+Multiple resolution options for offscreen ray march. +

+

Enumerator:
+ + + + + + +
eNvFlowMultiResRayMarchDisabled  +
eNvFlowMultiResRayMarch2x2  +
eNvFlowMultiResRayMarch4x4  +
eNvFlowMultiResRayMarch8x8  +
eNvFlowMultiResRayMarch16x16  +
+
+ +
+

+ +

+
+ + + + +
enum NvFlowVolumeRenderDownsample
+
+
+ +

+Downsample options for offscreen ray march. +

+

Enumerator:
+ + + +
eNvFlowVolumeRenderDownsampleNone  +
eNvFlowVolumeRenderDownsample2x2  +
+
+ +
+

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
NvFlowVolumeRender* NvFlowCreateVolumeRender (NvFlowContext *  context,
const NvFlowVolumeRenderDesc *  desc 
)
+
+
+ +

+Creates a volume render object.

+

Parameters:
+ + + +
[in] context The context for GPU resource allocation.
[in] desc Description for memory allocation.
+
+
Returns:
The created volume render object.
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseVolumeRender (NvFlowVolumeRender *  volumeRender  ) 
+
+
+ +

+Releases a volume render object.

+

Parameters:
+ + +
[in] volumeRender The volume render object to be released.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowVolumeRenderGridExport (NvFlowVolumeRender *  volumeRender,
NvFlowContext *  context,
NvFlowGridExport *  gridExport,
const NvFlowVolumeRenderParams *  params 
)
+
+
+ +

+Renders a grid export.

+

Parameters:
+ + + + + +
[in] volumeRender The volume render object to perform the rendering.
[in] context The context that created the volume render object.
[in] gridExport The grid export to ray march.
[in] params Parameters for rendering.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NvFlowGridExport* NvFlowVolumeRenderLightGridExport (NvFlowVolumeRender *  volumeRender,
NvFlowContext *  context,
NvFlowGridExport *  gridExport,
const NvFlowVolumeLightingParams *  params 
)
+
+
+ +

+Lights a grid export to produce another grid export that can be ray marched raw.

+

Parameters:
+ + + + + +
[in] volumeRender The volume render object to perform the lighting.
[in] context The context that created the volume render object.
[in] gridExport The grid export to ray march.
[in] params Parameters for lighting.
+
+
Returns:
The lit grid view.
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowVolumeRenderParamsDefaults (NvFlowVolumeRenderParams *  params  ) 
+
+
+ +

+Allows the application to request default volume render parameters from Flow.

+

Parameters:
+ + +
[out] params The parameters for Flow to fill out.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowVolumeRenderTexture3D (NvFlowVolumeRender *  volumeRender,
NvFlowContext *  context,
NvFlowTexture3D *  density,
const NvFlowVolumeRenderParams *  params 
)
+
+
+ +

+Renders a 3D texture.

+

Parameters:
+ + + + + +
[in] volumeRender The volume render object to perform the rendering.
[in] context The context that created the volume render object.
[in] density The 3D texture to ray march.
[in] params Parameters for rendering.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/group___nv_flow_volume_shadow.html b/docs/api/files/group___nv_flow_volume_shadow.html new file mode 100644 index 0000000..be68e2f --- /dev/null +++ b/docs/api/files/group___nv_flow_volume_shadow.html @@ -0,0 +1,291 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowVolumeShadow + + + + + + + + +
+

NvFlowVolumeShadow

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowVolumeShadowDebugRenderParams
 Parameters required to visualize shadow block allocation. More...
struct  NvFlowVolumeShadowDesc
 Description required to create volume shadow object. More...
struct  NvFlowVolumeShadowParams
 Parameters required to update volume shadows. More...
struct  NvFlowVolumeShadowStats
 Stats on currently active volume shadow. More...

Functions

NvFlowVolumeShadow * NvFlowCreateVolumeShadow (NvFlowContext *context, const NvFlowVolumeShadowDesc *desc)
void NvFlowReleaseVolumeShadow (NvFlowVolumeShadow *volumeShadow)
void NvFlowVolumeShadowDebugRender (NvFlowVolumeShadow *volumeShadow, NvFlowContext *context, const NvFlowVolumeShadowDebugRenderParams *params)
NvFlowGridExport * NvFlowVolumeShadowGetGridExport (NvFlowVolumeShadow *volumeShadow, NvFlowContext *context)
void NvFlowVolumeShadowGetStats (NvFlowVolumeShadow *volumeShadow, NvFlowVolumeShadowStats *stats)
void NvFlowVolumeShadowUpdate (NvFlowVolumeShadow *volumeShadow, NvFlowContext *context, NvFlowGridExport *gridExport, const NvFlowVolumeShadowParams *params)
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
NvFlowVolumeShadow* NvFlowCreateVolumeShadow (NvFlowContext *  context,
const NvFlowVolumeShadowDesc *  desc 
)
+
+
+ +

+Creates a volume shadow object.

+

Parameters:
+ + + +
[in] context The context for GPU resource allocation.
[in] desc Description for memory allocation.
+
+
Returns:
The created volume shadow object.
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseVolumeShadow (NvFlowVolumeShadow *  volumeShadow  ) 
+
+
+ +

+Releases a volume shadow object.

+

Parameters:
+ + +
[in] volumeShadow The volume shadow object to be released.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowVolumeShadowDebugRender (NvFlowVolumeShadow *  volumeShadow,
NvFlowContext *  context,
const NvFlowVolumeShadowDebugRenderParams *  params 
)
+
+
+ +

+Draw debug visualization of sparse volume shadow structure.

+

Parameters:
+ + + + +
[in] volumeShadow The volume shadow object.
[in] context The context that created the volume shadow object.
[in] params Parameters for debug visualization.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
NvFlowGridExport* NvFlowVolumeShadowGetGridExport (NvFlowVolumeShadow *  volumeShadow,
NvFlowContext *  context 
)
+
+
+ +

+Get grid export with shadow results. Currently, shadow results are placed in z component (the burn component).

+

Parameters:
+ + + +
[in] volumeShadow The volume shadow object.
[in] context The context that created the volume shadow object.
+
+
Returns:
Returns grid export with shadow results.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowVolumeShadowGetStats (NvFlowVolumeShadow *  volumeShadow,
NvFlowVolumeShadowStats *  stats 
)
+
+
+ +

+Get stats for latest shadow computation.

+

Parameters:
+ + + +
[in] volumeShadow The volume shadow object.
[out] stats Destination for shadow computation stats.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowVolumeShadowUpdate (NvFlowVolumeShadow *  volumeShadow,
NvFlowContext *  context,
NvFlowGridExport *  gridExport,
const NvFlowVolumeShadowParams *  params 
)
+
+
+ +

+Generate shadows from provided grid export.

+

Parameters:
+ + + + + +
[in] volumeShadow The volume shadow object.
[in] context The context that created the volume shadow object.
[in] gridExport The grid export to use for generating shadows.
[in] params Parameters for shadow generation.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/index.html b/docs/api/files/index.html new file mode 100644 index 0000000..dbc41d3 --- /dev/null +++ b/docs/api/files/index.html @@ -0,0 +1,11 @@ + + +NVIDIA(R) Flow(R) 1.0.0 API Reference + + + + + <a href="main.html">Frames are disabled. Click here to go to the main page.</a> + + + diff --git a/docs/api/files/main.html b/docs/api/files/main.html new file mode 100644 index 0000000..7aca3ab --- /dev/null +++ b/docs/api/files/main.html @@ -0,0 +1,34 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Main Page + + + + + + + + +
+

NVIDIA(R) Flow(R) 1.0.0 API Reference Documentation

+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/modules.html b/docs/api/files/modules.html new file mode 100644 index 0000000..48553cb --- /dev/null +++ b/docs/api/files/modules.html @@ -0,0 +1,52 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: Module Index + + + + + + + + +
+

Modules

Here is a list of all modules: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/nvflow_logo.png b/docs/api/files/nvflow_logo.png new file mode 100644 index 0000000..3b1f95b Binary files /dev/null and b/docs/api/files/nvflow_logo.png differ diff --git a/docs/api/files/struct_nv_flow_color_map_data.html b/docs/api/files/struct_nv_flow_color_map_data.html new file mode 100644 index 0000000..0ad242c --- /dev/null +++ b/docs/api/files/struct_nv_flow_color_map_data.html @@ -0,0 +1,85 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowColorMapData Struct Reference + + + + + + + + +
+

NvFlowColorMapData Struct Reference
+ +[NvFlowRenderMaterial] +

Required information for writing to a CPU mapped color map. +More... +

+#include <NvFlow.h> +

+ + + + + + + + +

Data Fields

NvFlowFloat4 * data
NvFlowUint dim
 Red, green, blue, alpha values.
+

Detailed Description

+Required information for writing to a CPU mapped color map.

Field Documentation

+ +
+
+ + + + +
NvFlowFloat4* NvFlowColorMapData::data
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowColorMapData::dim
+
+
+ +

+Red, green, blue, alpha values. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_context_desc_d3_d11.html b/docs/api/files/struct_nv_flow_context_desc_d3_d11.html new file mode 100644 index 0000000..b7f667b --- /dev/null +++ b/docs/api/files/struct_nv_flow_context_desc_d3_d11.html @@ -0,0 +1,78 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowContextDescD3D11 Struct Reference + + + + + + + + +
+

NvFlowContextDescD3D11 Struct Reference
+ +[NvFlowContextD3D11] +

#include <NvFlowContextD3D11.h> +

+ + + + + + + +

Data Fields

ID3D11Device * device
ID3D11DeviceContext * deviceContext
+

Field Documentation

+ +
+
+ + + + +
ID3D11Device* NvFlowContextDescD3D11::device
+
+
+ +

+ +

+

+ +

+
+ + + + +
ID3D11DeviceContext* NvFlowContextDescD3D11::deviceContext
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_context_desc_d3_d12.html b/docs/api/files/struct_nv_flow_context_desc_d3_d12.html new file mode 100644 index 0000000..059c3cf --- /dev/null +++ b/docs/api/files/struct_nv_flow_context_desc_d3_d12.html @@ -0,0 +1,184 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowContextDescD3D12 Struct Reference + + + + + + + + +
+

NvFlowContextDescD3D12 Struct Reference
+ +[NvFlowContextD3D12] +

#include <NvFlowContextD3D12.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields

ID3D12GraphicsCommandList * commandList
 The commandlist for recording.
ID3D12CommandQueue * commandQueue
 The commandQueue commandList will be submit on.
ID3D12Fence * commandQueueFence
 Fence marking events on this queue.
ID3D12Device * device
 The desired d3d12 device to use.
NvFlowDynamicDescriptorHeapD3D12 dynamicHeapCbvSrvUav
 Optional interface to share app descriptor heap with Flow.
UINT64 lastFenceCompleted
 The last fence completed on commandQueue.
UINT64 nextFenceValue
 The fence value signaled after commandList is submitted.
+

Field Documentation

+ +
+
+ + + + +
ID3D12GraphicsCommandList* NvFlowContextDescD3D12::commandList
+
+
+ +

+The commandlist for recording. +

+ +

+

+ +

+
+ + + + +
ID3D12CommandQueue* NvFlowContextDescD3D12::commandQueue
+
+
+ +

+The commandQueue commandList will be submit on. +

+ +

+

+ +

+
+ + + + +
ID3D12Fence* NvFlowContextDescD3D12::commandQueueFence
+
+
+ +

+Fence marking events on this queue. +

+ +

+

+ +

+
+ + + + +
ID3D12Device* NvFlowContextDescD3D12::device
+
+
+ +

+The desired d3d12 device to use. +

+ +

+

+ +

+
+ + + + +
NvFlowDynamicDescriptorHeapD3D12 NvFlowContextDescD3D12::dynamicHeapCbvSrvUav
+
+
+ +

+Optional interface to share app descriptor heap with Flow. +

+ +

+

+ +

+
+ + + + +
UINT64 NvFlowContextDescD3D12::lastFenceCompleted
+
+
+ +

+The last fence completed on commandQueue. +

+ +

+

+ +

+
+ + + + +
UINT64 NvFlowContextDescD3D12::nextFenceValue
+
+
+ +

+The fence value signaled after commandList is submitted. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_cross_section_desc.html b/docs/api/files/struct_nv_flow_cross_section_desc.html new file mode 100644 index 0000000..88b30cb --- /dev/null +++ b/docs/api/files/struct_nv_flow_cross_section_desc.html @@ -0,0 +1,68 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowCrossSectionDesc Struct Reference + + + + + + + + +
+

NvFlowCrossSectionDesc Struct Reference
+ +[NvFlowCrossSection] +

Description required to create cross section object. +More... +

+#include <NvFlow.h> +

+ + + + + + +

Data Fields

NvFlowGridExport * gridExport
 Grid export to serve as template for memory allocation.
+

Detailed Description

+Description required to create cross section object.

Field Documentation

+ +
+
+ + + + +
NvFlowGridExport* NvFlowCrossSectionDesc::gridExport
+
+
+ +

+Grid export to serve as template for memory allocation. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_cross_section_params.html b/docs/api/files/struct_nv_flow_cross_section_params.html new file mode 100644 index 0000000..619a350 --- /dev/null +++ b/docs/api/files/struct_nv_flow_cross_section_params.html @@ -0,0 +1,488 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowCrossSectionParams Struct Reference + + + + + + + + +
+

NvFlowCrossSectionParams Struct Reference
+ +[NvFlowCrossSection] +

Parameters needed to render cross section. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields

NvFlowFloat4 backgroundColor
 Background color.
NvFlowFloat4 cellColor
 Color for cell outline.
NvFlowUint crossSectionAxis
 Cross section to visualize, 0 to 2 range.
NvFlowFloat3 crossSectionPosition
 Offset in grid NDC for view.
float crossSectionScale
 Scale on cross section to allow zooming.
NvFlowDepthStencilView * depthStencilView
 Depth stencil view for depth testing with ray march.
bool fullscreen
 If true, covers entire viewport, if false, top right corner.
NvFlowGridExport * gridExport
 gridExport used for final rendering
NvFlowGridExport * gridExportDebugVis
 gridExport direct from simulation
float intensityScale
 scales the visualization intensity
NvFlowFloat4 lineColor
 Color to use for any lines drawn.
NvFlowRenderMaterialPool * materialPool
 Pool of materials to look for matches to GridMaterials.
bool outlineCells
 Draw lines around cell boundaries.
bool pointFilter
 If true, point filter so the cells are easy to see.
NvFlowFloat4x4 projectionMatrix
 Projection matrix, row major.
NvFlowGridTextureChannel renderChannel
 GridExport channel to render.
NvFlowVolumeRenderMode renderMode
 Render mode, see NvFlowVolumeRenderMode.
NvFlowRenderTargetView * renderTargetView
 Render target view to composite ray marched result against.
float vectorLengthScale
 Controls maximum velocity vector line length.
float velocityScale
 Scale to adjust vector length as a function of velocity.
bool velocityVectors
 If true, overlay geometric velocity vectors.
NvFlowFloat4x4 viewMatrix
 View matrix, row major.
+

Detailed Description

+Parameters needed to render cross section.

Field Documentation

+ +
+
+ + + + +
NvFlowFloat4 NvFlowCrossSectionParams::backgroundColor
+
+
+ +

+Background color. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4 NvFlowCrossSectionParams::cellColor
+
+
+ +

+Color for cell outline. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowCrossSectionParams::crossSectionAxis
+
+
+ +

+Cross section to visualize, 0 to 2 range. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowCrossSectionParams::crossSectionPosition
+
+
+ +

+Offset in grid NDC for view. +

+ +

+

+ +

+
+ + + + +
float NvFlowCrossSectionParams::crossSectionScale
+
+
+ +

+Scale on cross section to allow zooming. +

+ +

+

+ +

+
+ + + + +
NvFlowDepthStencilView* NvFlowCrossSectionParams::depthStencilView
+
+
+ +

+Depth stencil view for depth testing with ray march. +

+ +

+

+ +

+
+ + + + +
bool NvFlowCrossSectionParams::fullscreen
+
+
+ +

+If true, covers entire viewport, if false, top right corner. +

+ +

+

+ +

+
+ + + + +
NvFlowGridExport* NvFlowCrossSectionParams::gridExport
+
+
+ +

+gridExport used for final rendering +

+ +

+

+ +

+
+ + + + +
NvFlowGridExport* NvFlowCrossSectionParams::gridExportDebugVis
+
+
+ +

+gridExport direct from simulation +

+ +

+

+ +

+
+ + + + +
float NvFlowCrossSectionParams::intensityScale
+
+
+ +

+scales the visualization intensity +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4 NvFlowCrossSectionParams::lineColor
+
+
+ +

+Color to use for any lines drawn. +

+ +

+

+ +

+
+ + + + +
NvFlowRenderMaterialPool* NvFlowCrossSectionParams::materialPool
+
+
+ +

+Pool of materials to look for matches to GridMaterials. +

+ +

+

+ +

+
+ + + + +
bool NvFlowCrossSectionParams::outlineCells
+
+
+ +

+Draw lines around cell boundaries. +

+ +

+

+ +

+
+ + + + +
bool NvFlowCrossSectionParams::pointFilter
+
+
+ +

+If true, point filter so the cells are easy to see. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4x4 NvFlowCrossSectionParams::projectionMatrix
+
+
+ +

+Projection matrix, row major. +

+ +

+

+ +

+
+ + + + +
NvFlowGridTextureChannel NvFlowCrossSectionParams::renderChannel
+
+
+ +

+GridExport channel to render. +

+ +

+

+ +

+
+ + + + +
NvFlowVolumeRenderMode NvFlowCrossSectionParams::renderMode
+
+
+ +

+Render mode, see NvFlowVolumeRenderMode. +

+ +

+

+ +

+
+ + + + +
NvFlowRenderTargetView* NvFlowCrossSectionParams::renderTargetView
+
+
+ +

+Render target view to composite ray marched result against. +

+ +

+

+ +

+
+ + + + +
float NvFlowCrossSectionParams::vectorLengthScale
+
+
+ +

+Controls maximum velocity vector line length. +

+ +

+

+ +

+
+ + + + +
float NvFlowCrossSectionParams::velocityScale
+
+
+ +

+Scale to adjust vector length as a function of velocity. +

+ +

+

+ +

+
+ + + + +
bool NvFlowCrossSectionParams::velocityVectors
+
+
+ +

+If true, overlay geometric velocity vectors. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4x4 NvFlowCrossSectionParams::viewMatrix
+
+
+ +

+View matrix, row major. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_depth_stencil_view_desc_d3_d11.html b/docs/api/files/struct_nv_flow_depth_stencil_view_desc_d3_d11.html new file mode 100644 index 0000000..0c6a164 --- /dev/null +++ b/docs/api/files/struct_nv_flow_depth_stencil_view_desc_d3_d11.html @@ -0,0 +1,95 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowDepthStencilViewDescD3D11 Struct Reference + + + + + + + + +
+

NvFlowDepthStencilViewDescD3D11 Struct Reference
+ +[NvFlowContextD3D11] +

#include <NvFlowContextD3D11.h> +

+ + + + + + + + + +

Data Fields

ID3D11DepthStencilView * dsv
ID3D11ShaderResourceView * srv
D3D11_VIEWPORT viewport
+

Field Documentation

+ +
+
+ + + + +
ID3D11DepthStencilView* NvFlowDepthStencilViewDescD3D11::dsv
+
+
+ +

+ +

+

+ +

+
+ + + + +
ID3D11ShaderResourceView* NvFlowDepthStencilViewDescD3D11::srv
+
+
+ +

+ +

+

+ +

+
+ + + + +
D3D11_VIEWPORT NvFlowDepthStencilViewDescD3D11::viewport
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_depth_stencil_view_desc_d3_d12.html b/docs/api/files/struct_nv_flow_depth_stencil_view_desc_d3_d12.html new file mode 100644 index 0000000..3c33d2e --- /dev/null +++ b/docs/api/files/struct_nv_flow_depth_stencil_view_desc_d3_d12.html @@ -0,0 +1,163 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowDepthStencilViewDescD3D12 Struct Reference + + + + + + + + +
+

NvFlowDepthStencilViewDescD3D12 Struct Reference
+ +[NvFlowContextD3D12] +

#include <NvFlowContextD3D12.h> +

+ + + + + + + + + + + + + + + + + +

Data Fields

D3D12_RESOURCE_STATES currentState
D3D12_DEPTH_STENCIL_VIEW_DESC dsvDesc
D3D12_CPU_DESCRIPTOR_HANDLE dsvHandle
ID3D12Resource * resource
D3D12_SHADER_RESOURCE_VIEW_DESC srvDesc
D3D12_CPU_DESCRIPTOR_HANDLE srvHandle
D3D12_VIEWPORT viewport
+

Field Documentation

+ +
+
+ + + + +
D3D12_RESOURCE_STATES NvFlowDepthStencilViewDescD3D12::currentState
+
+
+ +

+ +

+

+ +

+
+ + + + +
D3D12_DEPTH_STENCIL_VIEW_DESC NvFlowDepthStencilViewDescD3D12::dsvDesc
+
+
+ +

+ +

+

+ +

+
+ + + + +
D3D12_CPU_DESCRIPTOR_HANDLE NvFlowDepthStencilViewDescD3D12::dsvHandle
+
+
+ +

+ +

+

+ +

+
+ + + + +
ID3D12Resource* NvFlowDepthStencilViewDescD3D12::resource
+
+
+ +

+ +

+

+ +

+
+ + + + +
D3D12_SHADER_RESOURCE_VIEW_DESC NvFlowDepthStencilViewDescD3D12::srvDesc
+
+
+ +

+ +

+

+ +

+
+ + + + +
D3D12_CPU_DESCRIPTOR_HANDLE NvFlowDepthStencilViewDescD3D12::srvHandle
+
+
+ +

+ +

+

+ +

+
+ + + + +
D3D12_VIEWPORT NvFlowDepthStencilViewDescD3D12::viewport
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_descriptor_reserve_handle_d3_d12.html b/docs/api/files/struct_nv_flow_descriptor_reserve_handle_d3_d12.html new file mode 100644 index 0000000..5381243 --- /dev/null +++ b/docs/api/files/struct_nv_flow_descriptor_reserve_handle_d3_d12.html @@ -0,0 +1,112 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowDescriptorReserveHandleD3D12 Struct Reference + + + + + + + + +
+

NvFlowDescriptorReserveHandleD3D12 Struct Reference
+ +[NvFlowContextD3D12] +

#include <NvFlowContextD3D12.h> +

+ + + + + + + + + + + +

Data Fields

D3D12_CPU_DESCRIPTOR_HANDLE cpuHandle
NvFlowUint descriptorSize
D3D12_GPU_DESCRIPTOR_HANDLE gpuHandle
ID3D12DescriptorHeap * heap
+

Field Documentation

+ +
+
+ + + + +
D3D12_CPU_DESCRIPTOR_HANDLE NvFlowDescriptorReserveHandleD3D12::cpuHandle
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowDescriptorReserveHandleD3D12::descriptorSize
+
+
+ +

+ +

+

+ +

+
+ + + + +
D3D12_GPU_DESCRIPTOR_HANDLE NvFlowDescriptorReserveHandleD3D12::gpuHandle
+
+
+ +

+ +

+

+ +

+
+ + + + +
ID3D12DescriptorHeap* NvFlowDescriptorReserveHandleD3D12::heap
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_device_desc.html b/docs/api/files/struct_nv_flow_device_desc.html new file mode 100644 index 0000000..cb832ce --- /dev/null +++ b/docs/api/files/struct_nv_flow_device_desc.html @@ -0,0 +1,108 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowDeviceDesc Struct Reference + + + + + + + + +
+

NvFlowDeviceDesc Struct Reference
+ +[NvFlowDevice] +

Description required for creating a Flow device. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + +

Data Fields

NvFlowUint adapterIdx
 preferred device index
bool autoSelectDevice
 if true, NvFlow tries to identify best compute device
NvFlowDeviceMode mode
 Type of device to create.
+

Detailed Description

+Description required for creating a Flow device.

Field Documentation

+ +
+
+ + + + +
NvFlowUint NvFlowDeviceDesc::adapterIdx
+
+
+ +

+preferred device index +

+ +

+

+ +

+
+ + + + +
bool NvFlowDeviceDesc::autoSelectDevice
+
+
+ +

+if true, NvFlow tries to identify best compute device +

+ +

+

+ +

+
+ + + + +
NvFlowDeviceMode NvFlowDeviceDesc::mode
+
+
+ +

+Type of device to create. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_device_queue_desc.html b/docs/api/files/struct_nv_flow_device_queue_desc.html new file mode 100644 index 0000000..013cb5a --- /dev/null +++ b/docs/api/files/struct_nv_flow_device_queue_desc.html @@ -0,0 +1,82 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowDeviceQueueDesc Struct Reference + + + + + + + + +
+

NvFlowDeviceQueueDesc Struct Reference
+ +[NvFlowDevice] +

Description required for creating a Flow device queue. +More... +

+#include <NvFlow.h> +

+ + + + + + + +

Data Fields

bool lowLatency
NvFlowDeviceQueueType queueType
+

Detailed Description

+Description required for creating a Flow device queue.

Field Documentation

+ +
+
+ + + + +
bool NvFlowDeviceQueueDesc::lowLatency
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowDeviceQueueType NvFlowDeviceQueueDesc::queueType
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_device_queue_status.html b/docs/api/files/struct_nv_flow_device_queue_status.html new file mode 100644 index 0000000..ff52edd --- /dev/null +++ b/docs/api/files/struct_nv_flow_device_queue_status.html @@ -0,0 +1,108 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowDeviceQueueStatus Struct Reference + + + + + + + + +
+

NvFlowDeviceQueueStatus Struct Reference
+ +[NvFlowDevice] +

Flow device queue status to allow app to throttle maximum queued work. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + +

Data Fields

NvFlowUint framesInFlight
 Number of flushes that have not completed work on the GPU.
NvFlowUint64 lastFenceCompleted
 The last fence completed on device queue.
NvFlowUint64 nextFenceValue
 The fence value signaled after flush.
+

Detailed Description

+Flow device queue status to allow app to throttle maximum queued work.

Field Documentation

+ +
+
+ + + + +
NvFlowUint NvFlowDeviceQueueStatus::framesInFlight
+
+
+ +

+Number of flushes that have not completed work on the GPU. +

+ +

+

+ +

+
+ + + + +
NvFlowUint64 NvFlowDeviceQueueStatus::lastFenceCompleted
+
+
+ +

+The last fence completed on device queue. +

+ +

+

+ +

+
+ + + + +
NvFlowUint64 NvFlowDeviceQueueStatus::nextFenceValue
+
+
+ +

+The fence value signaled after flush. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_dim.html b/docs/api/files/struct_nv_flow_dim.html new file mode 100644 index 0000000..6963c03 --- /dev/null +++ b/docs/api/files/struct_nv_flow_dim.html @@ -0,0 +1,92 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowDim Struct Reference + + + + + + + + +
+

NvFlowDim Struct Reference

#include <NvFlowTypes.h> +

+ + + + + + + + + +

Data Fields

NvFlowUint x
NvFlowUint y
NvFlowUint z
+

Field Documentation

+ +
+
+ + + + +
NvFlowUint NvFlowDim::x
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowDim::y
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowDim::z
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_dynamic_descriptor_heap_d3_d12.html b/docs/api/files/struct_nv_flow_dynamic_descriptor_heap_d3_d12.html new file mode 100644 index 0000000..a4d1914 --- /dev/null +++ b/docs/api/files/struct_nv_flow_dynamic_descriptor_heap_d3_d12.html @@ -0,0 +1,78 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowDynamicDescriptorHeapD3D12 Struct Reference + + + + + + + + +
+

NvFlowDynamicDescriptorHeapD3D12 Struct Reference
+ +[NvFlowContextD3D12] +

#include <NvFlowContextD3D12.h> +

+ + + + + + + +

Data Fields

NvFlowDescriptorReserveHandleD3D12(* reserveDescriptors )(void *userdata, NvFlowUint numDescriptors, NvFlowUint64 lastFenceCompleted, NvFlowUint64 nextFenceValue)
void * userdata
+

Field Documentation

+ +
+
+ + + + +
NvFlowDescriptorReserveHandleD3D12(* NvFlowDynamicDescriptorHeapD3D12::reserveDescriptors)(void *userdata, NvFlowUint numDescriptors, NvFlowUint64 lastFenceCompleted, NvFlowUint64 nextFenceValue)
+
+
+ +

+ +

+

+ +

+
+ + + + +
void* NvFlowDynamicDescriptorHeapD3D12::userdata
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_float3.html b/docs/api/files/struct_nv_flow_float3.html new file mode 100644 index 0000000..d7222eb --- /dev/null +++ b/docs/api/files/struct_nv_flow_float3.html @@ -0,0 +1,92 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowFloat3 Struct Reference + + + + + + + + +
+

NvFlowFloat3 Struct Reference

#include <NvFlowTypes.h> +

+ + + + + + + + + +

Data Fields

float x
float y
float z
+

Field Documentation

+ +
+
+ + + + +
float NvFlowFloat3::x
+
+
+ +

+ +

+

+ +

+
+ + + + +
float NvFlowFloat3::y
+
+
+ +

+ +

+

+ +

+
+ + + + +
float NvFlowFloat3::z
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_float4.html b/docs/api/files/struct_nv_flow_float4.html new file mode 100644 index 0000000..8c118e1 --- /dev/null +++ b/docs/api/files/struct_nv_flow_float4.html @@ -0,0 +1,109 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowFloat4 Struct Reference + + + + + + + + +
+

NvFlowFloat4 Struct Reference

#include <NvFlowTypes.h> +

+ + + + + + + + + + + +

Data Fields

float w
float x
float y
float z
+

Field Documentation

+ +
+
+ + + + +
float NvFlowFloat4::w
+
+
+ +

+ +

+

+ +

+
+ + + + +
float NvFlowFloat4::x
+
+
+ +

+ +

+

+ +

+
+ + + + +
float NvFlowFloat4::y
+
+
+ +

+ +

+

+ +

+
+ + + + +
float NvFlowFloat4::z
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_float4x4.html b/docs/api/files/struct_nv_flow_float4x4.html new file mode 100644 index 0000000..80e1492 --- /dev/null +++ b/docs/api/files/struct_nv_flow_float4x4.html @@ -0,0 +1,109 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowFloat4x4 Struct Reference + + + + + + + + +
+

NvFlowFloat4x4 Struct Reference

#include <NvFlowTypes.h> +

+ + + + + + + + + + + +

Data Fields

NvFlowFloat4 w
NvFlowFloat4 x
NvFlowFloat4 y
NvFlowFloat4 z
+

Field Documentation

+ +
+
+ + + + +
NvFlowFloat4 NvFlowFloat4x4::w
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4 NvFlowFloat4x4::x
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4 NvFlowFloat4x4::y
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4 NvFlowFloat4x4::z
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_desc.html b/docs/api/files/struct_nv_flow_grid_desc.html new file mode 100644 index 0000000..fa021b6 --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_desc.html @@ -0,0 +1,208 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridDesc Struct Reference + + + + + + + + +
+

NvFlowGridDesc Struct Reference
+ +[NvFlowGrid] +

Description required to create a grid. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields

float coarseResidentScaleFactor
 Allows relative increase of resident scale for coarse sparse textures.
NvFlowMultiRes densityMultiRes
 Number of density cells per velocity cell.
bool enableVTR
 Enable use of volume tiled resources, if supported.
NvFlowFloat3 halfSize
 Initial half size of axis aligned bounding box.
NvFlowFloat3 initialLocation
 Initial location of axis aligned bounding box.
bool lowLatencyMapping
 Faster mapping updates, more mapping overhead but less prediction required.
float residentScale
 Fraction of virtual cells to allocate memory for.
NvFlowDim virtualDim
 Resolution of virtual address space inside of bounding box.
+

Detailed Description

+Description required to create a grid.

Field Documentation

+ +
+
+ + + + +
float NvFlowGridDesc::coarseResidentScaleFactor
+
+
+ +

+Allows relative increase of resident scale for coarse sparse textures. +

+ +

+

+ +

+
+ + + + +
NvFlowMultiRes NvFlowGridDesc::densityMultiRes
+
+
+ +

+Number of density cells per velocity cell. +

+ +

+

+ +

+
+ + + + +
bool NvFlowGridDesc::enableVTR
+
+
+ +

+Enable use of volume tiled resources, if supported. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowGridDesc::halfSize
+
+
+ +

+Initial half size of axis aligned bounding box. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowGridDesc::initialLocation
+
+
+ +

+Initial location of axis aligned bounding box. +

+ +

+

+ +

+
+ + + + +
bool NvFlowGridDesc::lowLatencyMapping
+
+
+ +

+Faster mapping updates, more mapping overhead but less prediction required. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridDesc::residentScale
+
+
+ +

+Fraction of virtual cells to allocate memory for. +

+ +

+

+ +

+
+ + + + +
NvFlowDim NvFlowGridDesc::virtualDim
+
+
+ +

+Resolution of virtual address space inside of bounding box. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_emit_custom_alloc_params.html b/docs/api/files/struct_nv_flow_grid_emit_custom_alloc_params.html new file mode 100644 index 0000000..45eef00 --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_emit_custom_alloc_params.html @@ -0,0 +1,148 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridEmitCustomAllocParams Struct Reference + + + + + + + + +
+

NvFlowGridEmitCustomAllocParams Struct Reference
+ +[NvFlowGridEmitCustom] +

Necessary parameters/resources for custom grid block allocation. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + +

Data Fields

NvFlowFloat3 gridHalfSize
 Half size of grid's axis aligned bounding box.
NvFlowFloat3 gridLocation
 Location of grid's axis aligned bounding box.
NvFlowDim maskDim
 Mask dimensions.
NvFlowResourceRW * maskResourceRW
 Integer mask, write 1u where allocation is desired.
NvFlowGridMaterialHandle material
 Grid material.
+

Detailed Description

+Necessary parameters/resources for custom grid block allocation.

Field Documentation

+ +
+
+ + + + +
NvFlowFloat3 NvFlowGridEmitCustomAllocParams::gridHalfSize
+
+
+ +

+Half size of grid's axis aligned bounding box. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowGridEmitCustomAllocParams::gridLocation
+
+
+ +

+Location of grid's axis aligned bounding box. +

+ +

+

+ +

+
+ + + + +
NvFlowDim NvFlowGridEmitCustomAllocParams::maskDim
+
+
+ +

+Mask dimensions. +

+ +

+

+ +

+
+ + + + +
NvFlowResourceRW* NvFlowGridEmitCustomAllocParams::maskResourceRW
+
+
+ +

+Integer mask, write 1u where allocation is desired. +

+ +

+

+ +

+
+ + + + +
NvFlowGridMaterialHandle NvFlowGridEmitCustomAllocParams::material
+
+
+ +

+Grid material. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_emit_custom_emit_layer_params.html b/docs/api/files/struct_nv_flow_grid_emit_custom_emit_layer_params.html new file mode 100644 index 0000000..0864f12 --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_emit_custom_emit_layer_params.html @@ -0,0 +1,228 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridEmitCustomEmitLayerParams Struct Reference + + + + + + + + +
+

NvFlowGridEmitCustomEmitLayerParams Struct Reference
+ +[NvFlowGridEmitCustom] +

Necessary parameters/resources for custom emit operations. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields

NvFlowResource * blockList
 List of active blocks.
NvFlowResource * blockTable
 Table to map virtual blocks to real blocks.
NvFlowResourceRW * dataRW [2u]
 Read/Write 3D textures for channel data.
NvFlowFloat3 gridHalfSize
 Half size of grid's axis aligned bounding box.
NvFlowFloat3 gridLocation
 Location of grid's axis aligned bounding box.
NvFlowGridMaterialHandle material
 Grid material.
NvFlowUint maxBlocks
 Maximum possible active blocks.
NvFlowUint numBlocks
 Number of active blocks.
NvFlowShaderPointParams shaderParams
 Parameters used in GPU side operations.
+

Detailed Description

+Necessary parameters/resources for custom emit operations.

Field Documentation

+ +
+
+ + + + +
NvFlowResource* NvFlowGridEmitCustomEmitLayerParams::blockList
+
+
+ +

+List of active blocks. +

+ +

+

+ +

+
+ + + + +
NvFlowResource* NvFlowGridEmitCustomEmitLayerParams::blockTable
+
+
+ +

+Table to map virtual blocks to real blocks. +

+ +

+

+ +

+
+ + + + +
NvFlowResourceRW* NvFlowGridEmitCustomEmitLayerParams::dataRW[2u]
+
+
+ +

+Read/Write 3D textures for channel data. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowGridEmitCustomEmitLayerParams::gridHalfSize
+
+
+ +

+Half size of grid's axis aligned bounding box. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowGridEmitCustomEmitLayerParams::gridLocation
+
+
+ +

+Location of grid's axis aligned bounding box. +

+ +

+

+ +

+
+ + + + +
NvFlowGridMaterialHandle NvFlowGridEmitCustomEmitLayerParams::material
+
+
+ +

+Grid material. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowGridEmitCustomEmitLayerParams::maxBlocks
+
+
+ +

+Maximum possible active blocks. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowGridEmitCustomEmitLayerParams::numBlocks
+
+
+ +

+Number of active blocks. +

+ +

+

+ +

+
+ + + + +
NvFlowShaderPointParams NvFlowGridEmitCustomEmitLayerParams::shaderParams
+
+
+ +

+Parameters used in GPU side operations. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_emit_custom_emit_params.html b/docs/api/files/struct_nv_flow_grid_emit_custom_emit_params.html new file mode 100644 index 0000000..2f88900 --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_emit_custom_emit_params.html @@ -0,0 +1,108 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridEmitCustomEmitParams Struct Reference + + + + + + + + +
+

NvFlowGridEmitCustomEmitParams Struct Reference
+ +[NvFlowGridEmitCustom] +

Handle for requesting per layer emitter data. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + +

Data Fields

void * flowInternal
 For Flow internal use, do not modify.
NvFlowGrid * grid
 The grid associated with this callback.
NvFlowUint numLayers
 The number of layers to write to.
+

Detailed Description

+Handle for requesting per layer emitter data.

Field Documentation

+ +
+
+ + + + +
void* NvFlowGridEmitCustomEmitParams::flowInternal
+
+
+ +

+For Flow internal use, do not modify. +

+ +

+

+ +

+
+ + + + +
NvFlowGrid* NvFlowGridEmitCustomEmitParams::grid
+
+
+ +

+The grid associated with this callback. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowGridEmitCustomEmitParams::numLayers
+
+
+ +

+The number of layers to write to. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_emit_params.html b/docs/api/files/struct_nv_flow_grid_emit_params.html new file mode 100644 index 0000000..dd9e477 --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_emit_params.html @@ -0,0 +1,688 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridEmitParams Struct Reference + + + + + + + + +
+

NvFlowGridEmitParams Struct Reference
+ +[NvFlowGridEmit] +

Parameters for both emission and collision. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields

float allocationPredict
 Higher values cause extra allocation based on linear velocity and predict velocity.
NvFlowFloat3 allocationScale
 Higher values cause more blocks to allocate around emitter; 0.f means no allocation, 1.f is default.
NvFlowFloat4x4 bounds
 Transform from emitter ndc to world space.
NvFlowFloat3 centerOfMass
 Center of mass in emitter local coordinate space.
float deltaTime
 DeltaTime used to compute impulse.
NvFlowUint emitMode
 Emitter behavior, based on NvFlowGridEmitMode, 0u is default.
float fuel
 Target fuel.
float fuelCoupleRate
 Rate of correction to target, inf means instantaneous.
float fuelRelease
 Fuel released when temperature exceeds release temperature.
float fuelReleaseTemp
 Minimum temperature to release fuelRelease additional fuel.
NvFlowFloat4x4 localToWorld
 Transform from shape local space to world space.
NvFlowGridMaterialHandle material
 Material for this emitter.
float maxActiveDist
 Maximum distance value for active emission.
float maxEdgeDist
 Distance before maxActiveDist to 0.0 emitter opacity.
float minActiveDist
 Minimum distance value for active emission.
float minEdgeDist
 Distance from minActiveDist to 1.0 emitter opacity.
NvFlowUint numSubSteps
 Numbers of interations to perform on cell value.
NvFlowFloat3 predictVelocity
 Velocity used only for predict.
float predictVelocityWeight
 Blend weight between linearVelocity and predictVelocity.
float shapeDistScale
 Scale to apply to SDF value.
NvFlowUint shapeRangeOffset
 Start of shape range, offset in number of Shapes.
NvFlowUint shapeRangeSize
 Size of shape range, in number of Shapes.
NvFlowShapeType shapeType
 Type of shape in the set.
float slipFactor
 0.0 => no slip, fully damped; 1.0 => full slip
float slipThickness
 Thickness of slip boundary region.
float smoke
 Target smoke.
float smokeCoupleRate
 Rate of correction to target, inf means instantaneous.
float temperature
 Target temperature.
float temperatureCoupleRate
 Rate of correction to target, inf means instantaneous.
NvFlowFloat3 velocityAngular
 Angular velocity, in world units, emitter direction.
NvFlowFloat3 velocityCoupleRate
 Rate of correction to target, inf means instantaneous.
NvFlowFloat3 velocityLinear
 Linear velocity, in world units, emitter direction.
+

Detailed Description

+Parameters for both emission and collision.

Field Documentation

+ +
+
+ + + + +
float NvFlowGridEmitParams::allocationPredict
+
+
+ +

+Higher values cause extra allocation based on linear velocity and predict velocity. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowGridEmitParams::allocationScale
+
+
+ +

+Higher values cause more blocks to allocate around emitter; 0.f means no allocation, 1.f is default. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4x4 NvFlowGridEmitParams::bounds
+
+
+ +

+Transform from emitter ndc to world space. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowGridEmitParams::centerOfMass
+
+
+ +

+Center of mass in emitter local coordinate space. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::deltaTime
+
+
+ +

+DeltaTime used to compute impulse. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowGridEmitParams::emitMode
+
+
+ +

+Emitter behavior, based on NvFlowGridEmitMode, 0u is default. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::fuel
+
+
+ +

+Target fuel. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::fuelCoupleRate
+
+
+ +

+Rate of correction to target, inf means instantaneous. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::fuelRelease
+
+
+ +

+Fuel released when temperature exceeds release temperature. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::fuelReleaseTemp
+
+
+ +

+Minimum temperature to release fuelRelease additional fuel. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4x4 NvFlowGridEmitParams::localToWorld
+
+
+ +

+Transform from shape local space to world space. +

+ +

+

+ +

+
+ + + + +
NvFlowGridMaterialHandle NvFlowGridEmitParams::material
+
+
+ +

+Material for this emitter. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::maxActiveDist
+
+
+ +

+Maximum distance value for active emission. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::maxEdgeDist
+
+
+ +

+Distance before maxActiveDist to 0.0 emitter opacity. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::minActiveDist
+
+
+ +

+Minimum distance value for active emission. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::minEdgeDist
+
+
+ +

+Distance from minActiveDist to 1.0 emitter opacity. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowGridEmitParams::numSubSteps
+
+
+ +

+Numbers of interations to perform on cell value. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowGridEmitParams::predictVelocity
+
+
+ +

+Velocity used only for predict. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::predictVelocityWeight
+
+
+ +

+Blend weight between linearVelocity and predictVelocity. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::shapeDistScale
+
+
+ +

+Scale to apply to SDF value. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowGridEmitParams::shapeRangeOffset
+
+
+ +

+Start of shape range, offset in number of Shapes. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowGridEmitParams::shapeRangeSize
+
+
+ +

+Size of shape range, in number of Shapes. +

+ +

+

+ +

+
+ + + + +
NvFlowShapeType NvFlowGridEmitParams::shapeType
+
+
+ +

+Type of shape in the set. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::slipFactor
+
+
+ +

+0.0 => no slip, fully damped; 1.0 => full slip +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::slipThickness
+
+
+ +

+Thickness of slip boundary region. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::smoke
+
+
+ +

+Target smoke. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::smokeCoupleRate
+
+
+ +

+Rate of correction to target, inf means instantaneous. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::temperature
+
+
+ +

+Target temperature. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridEmitParams::temperatureCoupleRate
+
+
+ +

+Rate of correction to target, inf means instantaneous. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowGridEmitParams::velocityAngular
+
+
+ +

+Angular velocity, in world units, emitter direction. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowGridEmitParams::velocityCoupleRate
+
+
+ +

+Rate of correction to target, inf means instantaneous. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowGridEmitParams::velocityLinear
+
+
+ +

+Linear velocity, in world units, emitter direction. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_export_debug_vis_view.html b/docs/api/files/struct_nv_flow_grid_export_debug_vis_view.html new file mode 100644 index 0000000..5c6339d --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_export_debug_vis_view.html @@ -0,0 +1,228 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridExportDebugVisView Struct Reference + + + + + + + + +
+

NvFlowGridExportDebugVisView Struct Reference
+ +[NvFlowGridExport] +

Debug vis data. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields

NvFlowFloat4x4 * bounds
 Array of emitter bounds.
NvFlowGridExportSimpleShape * boxes
 Array of boxes.
NvFlowGridExportSimpleShape * capsules
 Array of capsules.
NvFlowGridDebugVisFlags debugVisFlags
 Debug vis flags to indicate what data is valid.
NvFlowUint numBounds
 Number of emitter bounds in array.
NvFlowUint numBoxes
 Number of boxes in array.
NvFlowUint numCapsules
 Number of capsules in array.
NvFlowUint numSpheres
 Number of spheres in array.
NvFlowGridExportSimpleShape * spheres
 Array of spheres.
+

Detailed Description

+Debug vis data.

Field Documentation

+ +
+
+ + + + +
NvFlowFloat4x4* NvFlowGridExportDebugVisView::bounds
+
+
+ +

+Array of emitter bounds. +

+ +

+

+ +

+
+ + + + +
NvFlowGridExportSimpleShape* NvFlowGridExportDebugVisView::boxes
+
+
+ +

+Array of boxes. +

+ +

+

+ +

+
+ + + + +
NvFlowGridExportSimpleShape* NvFlowGridExportDebugVisView::capsules
+
+
+ +

+Array of capsules. +

+ +

+

+ +

+
+ + + + +
NvFlowGridDebugVisFlags NvFlowGridExportDebugVisView::debugVisFlags
+
+
+ +

+Debug vis flags to indicate what data is valid. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowGridExportDebugVisView::numBounds
+
+
+ +

+Number of emitter bounds in array. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowGridExportDebugVisView::numBoxes
+
+
+ +

+Number of boxes in array. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowGridExportDebugVisView::numCapsules
+
+
+ +

+Number of capsules in array. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowGridExportDebugVisView::numSpheres
+
+
+ +

+Number of spheres in array. +

+ +

+

+ +

+
+ + + + +
NvFlowGridExportSimpleShape* NvFlowGridExportDebugVisView::spheres
+
+
+ +

+Array of spheres. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_export_handle.html b/docs/api/files/struct_nv_flow_grid_export_handle.html new file mode 100644 index 0000000..23bbbfa --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_export_handle.html @@ -0,0 +1,108 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridExportHandle Struct Reference + + + + + + + + +
+

NvFlowGridExportHandle Struct Reference
+ +[NvFlowGridExport] +

Texture channel export handle. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + +

Data Fields

NvFlowGridTextureChannel channel
 Grid texture channel this handle is for.
NvFlowGridExport * gridExport
 GridExport that created this handle.
NvFlowUint numLayerViews
 Numbers of layers in this grid texture channel.
+

Detailed Description

+Texture channel export handle.

Field Documentation

+ +
+
+ + + + +
NvFlowGridTextureChannel NvFlowGridExportHandle::channel
+
+
+ +

+Grid texture channel this handle is for. +

+ +

+

+ +

+
+ + + + +
NvFlowGridExport* NvFlowGridExportHandle::gridExport
+
+
+ +

+GridExport that created this handle. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowGridExportHandle::numLayerViews
+
+
+ +

+Numbers of layers in this grid texture channel. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_export_import_layer_mapping.html b/docs/api/files/struct_nv_flow_grid_export_import_layer_mapping.html new file mode 100644 index 0000000..3e4e9c3 --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_export_import_layer_mapping.html @@ -0,0 +1,128 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridExportImportLayerMapping Struct Reference + + + + + + + + +
+

NvFlowGridExportImportLayerMapping Struct Reference
+ +[NvFlowGridExport] +

Description of a single exported layer. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + +

Data Fields

NvFlowResource * blockList
 Block list for this layer.
NvFlowResource * blockTable
 Block table for this layer.
NvFlowGridMaterialHandle material
 Grid material associated with this layer.
NvFlowUint numBlocks
 Number of active blocks in this layer.
+

Detailed Description

+Description of a single exported layer.

Field Documentation

+ +
+
+ + + + +
NvFlowResource* NvFlowGridExportImportLayerMapping::blockList
+
+
+ +

+Block list for this layer. +

+ +

+

+ +

+
+ + + + +
NvFlowResource* NvFlowGridExportImportLayerMapping::blockTable
+
+
+ +

+Block table for this layer. +

+ +

+

+ +

+
+ + + + +
NvFlowGridMaterialHandle NvFlowGridExportImportLayerMapping::material
+
+
+ +

+Grid material associated with this layer. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowGridExportImportLayerMapping::numBlocks
+
+
+ +

+Number of active blocks in this layer. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_export_import_layered_mapping.html b/docs/api/files/struct_nv_flow_grid_export_import_layered_mapping.html new file mode 100644 index 0000000..c4632bb --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_export_import_layered_mapping.html @@ -0,0 +1,148 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridExportImportLayeredMapping Struct Reference + + + + + + + + +
+

NvFlowGridExportImportLayeredMapping Struct Reference
+ +[NvFlowGridExport] +

Description applying to all exported layers. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + +

Data Fields

NvFlowUint2 * layeredBlockListCPU
 CPU list of active blocks, in (blockIdx, layerIdx) pairs.
NvFlowUint layeredNumBlocks
 Number of blocks in layeredBlockListCPU.
NvFlowUint maxBlocks
 Maximum blocks active, for all layers.
NvFlowFloat4x4 modelMatrix
 Transform from grid NDC to world.
NvFlowShaderLinearParams shaderParams
 Shader parameters for address translation.
+

Detailed Description

+Description applying to all exported layers.

Field Documentation

+ +
+
+ + + + +
NvFlowUint2* NvFlowGridExportImportLayeredMapping::layeredBlockListCPU
+
+
+ +

+CPU list of active blocks, in (blockIdx, layerIdx) pairs. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowGridExportImportLayeredMapping::layeredNumBlocks
+
+
+ +

+Number of blocks in layeredBlockListCPU. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowGridExportImportLayeredMapping::maxBlocks
+
+
+ +

+Maximum blocks active, for all layers. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4x4 NvFlowGridExportImportLayeredMapping::modelMatrix
+
+
+ +

+Transform from grid NDC to world. +

+ +

+

+ +

+
+ + + + +
NvFlowShaderLinearParams NvFlowGridExportImportLayeredMapping::shaderParams
+
+
+ +

+Shader parameters for address translation. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_export_layer_view.html b/docs/api/files/struct_nv_flow_grid_export_layer_view.html new file mode 100644 index 0000000..2f22186 --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_export_layer_view.html @@ -0,0 +1,88 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridExportLayerView Struct Reference + + + + + + + + +
+

NvFlowGridExportLayerView Struct Reference
+ +[NvFlowGridExport] +

Description of a single exported layer. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + +

Data Fields

NvFlowResource * data
 Data resource for this layer view.
NvFlowGridExportImportLayerMapping mapping
 Mapping of data to virtual space.
+

Detailed Description

+Description of a single exported layer.

Field Documentation

+ +
+
+ + + + +
NvFlowResource* NvFlowGridExportLayerView::data
+
+
+ +

+Data resource for this layer view. +

+ +

+

+ +

+
+ + + + +
NvFlowGridExportImportLayerMapping NvFlowGridExportLayerView::mapping
+
+
+ +

+Mapping of data to virtual space. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_export_layered_view.html b/docs/api/files/struct_nv_flow_grid_export_layered_view.html new file mode 100644 index 0000000..79afac4 --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_export_layered_view.html @@ -0,0 +1,68 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridExportLayeredView Struct Reference + + + + + + + + +
+

NvFlowGridExportLayeredView Struct Reference
+ +[NvFlowGridExport] +

Description applying to all exported layers. +More... +

+#include <NvFlow.h> +

+ + + + + + +

Data Fields

NvFlowGridExportImportLayeredMapping mapping
 Mapping parameters uniform across layers.
+

Detailed Description

+Description applying to all exported layers.

Field Documentation

+ +
+
+ + + + +
NvFlowGridExportImportLayeredMapping NvFlowGridExportLayeredView::mapping
+
+
+ +

+Mapping parameters uniform across layers. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_export_simple_shape.html b/docs/api/files/struct_nv_flow_grid_export_simple_shape.html new file mode 100644 index 0000000..4477a3b --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_export_simple_shape.html @@ -0,0 +1,88 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridExportSimpleShape Struct Reference + + + + + + + + +
+

NvFlowGridExportSimpleShape Struct Reference
+ +[NvFlowGridExport] +

Data to visualize simple shape. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + +

Data Fields

NvFlowFloat4x4 localToWorld
 Transform from shape local to world space.
NvFlowShapeDesc shapeDesc
 Shape desc to visualize.
+

Detailed Description

+Data to visualize simple shape.

Field Documentation

+ +
+
+ + + + +
NvFlowFloat4x4 NvFlowGridExportSimpleShape::localToWorld
+
+
+ +

+Transform from shape local to world space. +

+ +

+

+ +

+
+ + + + +
NvFlowShapeDesc NvFlowGridExportSimpleShape::shapeDesc
+
+
+ +

+Shape desc to visualize. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_import_desc.html b/docs/api/files/struct_nv_flow_grid_import_desc.html new file mode 100644 index 0000000..af7a362 --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_import_desc.html @@ -0,0 +1,68 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridImportDesc Struct Reference + + + + + + + + +
+

NvFlowGridImportDesc Struct Reference
+ +[NvFlowGridImport] +

Description required to create GridImport. +More... +

+#include <NvFlow.h> +

+ + + + + + +

Data Fields

NvFlowGridExport * gridExport
 Grid export to use as template for allocation.
+

Detailed Description

+Description required to create GridImport.

Field Documentation

+ +
+
+ + + + +
NvFlowGridExport* NvFlowGridImportDesc::gridExport
+
+
+ +

+Grid export to use as template for allocation. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_import_handle.html b/docs/api/files/struct_nv_flow_grid_import_handle.html new file mode 100644 index 0000000..20072de --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_import_handle.html @@ -0,0 +1,108 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridImportHandle Struct Reference + + + + + + + + +
+

NvFlowGridImportHandle Struct Reference
+ +[NvFlowGridImport] +

Texture channel handle. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + +

Data Fields

NvFlowGridTextureChannel channel
 Grid texture channel this handle is for.
NvFlowGridImport * gridImport
 Grid import that created this handle.
NvFlowUint numLayerViews
 Number of layers in this grid texture channel.
+

Detailed Description

+Texture channel handle.

Field Documentation

+ +
+
+ + + + +
NvFlowGridTextureChannel NvFlowGridImportHandle::channel
+
+
+ +

+Grid texture channel this handle is for. +

+ +

+

+ +

+
+ + + + +
NvFlowGridImport* NvFlowGridImportHandle::gridImport
+
+
+ +

+Grid import that created this handle. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowGridImportHandle::numLayerViews
+
+
+ +

+Number of layers in this grid texture channel. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_import_layer_view.html b/docs/api/files/struct_nv_flow_grid_import_layer_view.html new file mode 100644 index 0000000..5967f7d --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_import_layer_view.html @@ -0,0 +1,128 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridImportLayerView Struct Reference + + + + + + + + +
+

NvFlowGridImportLayerView Struct Reference
+ +[NvFlowGridImport] +

Description of a single imported layer. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + +

Data Fields

NvFlowResourceRW * blockListRW
 If StateCPU path is used, this needs to be written, else is nullptr.
NvFlowResourceRW * blockTableRW
 If StateCPU path is used, this needs to be written, else is nullptr.
NvFlowResourceRW * dataRW
 This always should be written.
NvFlowGridExportImportLayerMapping mapping
 Mapping of data to virtual space.
+

Detailed Description

+Description of a single imported layer.

Field Documentation

+ +
+
+ + + + +
NvFlowResourceRW* NvFlowGridImportLayerView::blockListRW
+
+
+ +

+If StateCPU path is used, this needs to be written, else is nullptr. +

+ +

+

+ +

+
+ + + + +
NvFlowResourceRW* NvFlowGridImportLayerView::blockTableRW
+
+
+ +

+If StateCPU path is used, this needs to be written, else is nullptr. +

+ +

+

+ +

+
+ + + + +
NvFlowResourceRW* NvFlowGridImportLayerView::dataRW
+
+
+ +

+This always should be written. +

+ +

+

+ +

+
+ + + + +
NvFlowGridExportImportLayerMapping NvFlowGridImportLayerView::mapping
+
+
+ +

+Mapping of data to virtual space. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_import_layered_view.html b/docs/api/files/struct_nv_flow_grid_import_layered_view.html new file mode 100644 index 0000000..d859631 --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_import_layered_view.html @@ -0,0 +1,68 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridImportLayeredView Struct Reference + + + + + + + + +
+

NvFlowGridImportLayeredView Struct Reference
+ +[NvFlowGridImport] +

Description applying to all imported layers. +More... +

+#include <NvFlow.h> +

+ + + + + + +

Data Fields

NvFlowGridExportImportLayeredMapping mapping
 Mapping parameters uniform across layers.
+

Detailed Description

+Description applying to all imported layers.

Field Documentation

+ +
+
+ + + + +
NvFlowGridExportImportLayeredMapping NvFlowGridImportLayeredView::mapping
+
+
+ +

+Mapping parameters uniform across layers. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_import_params.html b/docs/api/files/struct_nv_flow_grid_import_params.html new file mode 100644 index 0000000..50f1fef --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_import_params.html @@ -0,0 +1,108 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridImportParams Struct Reference + + + + + + + + +
+

NvFlowGridImportParams Struct Reference
+ +[NvFlowGridImport] +

Parameters for grabbing import view. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + +

Data Fields

NvFlowGridTextureChannel channel
 Grid texture channel to generate import data for.
NvFlowGridExport * gridExport
 Grid export to serve as template for grid import.
NvFlowGridImportMode importMode
 Import mode, determines import data format.
+

Detailed Description

+Parameters for grabbing import view.

Field Documentation

+ +
+
+ + + + +
NvFlowGridTextureChannel NvFlowGridImportParams::channel
+
+
+ +

+Grid texture channel to generate import data for. +

+ +

+

+ +

+
+ + + + +
NvFlowGridExport* NvFlowGridImportParams::gridExport
+
+
+ +

+Grid export to serve as template for grid import. +

+ +

+

+ +

+
+ + + + +
NvFlowGridImportMode NvFlowGridImportParams::importMode
+
+
+ +

+Import mode, determines import data format. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_import_state_c_p_u_params.html b/docs/api/files/struct_nv_flow_grid_import_state_c_p_u_params.html new file mode 100644 index 0000000..66eacab --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_import_state_c_p_u_params.html @@ -0,0 +1,108 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridImportStateCPUParams Struct Reference + + + + + + + + +
+

NvFlowGridImportStateCPUParams Struct Reference
+ +[NvFlowGridImport] +

Parameters for grabbing import view. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + +

Data Fields

NvFlowGridTextureChannel channel
 Grid texture channel to generate import data for.
NvFlowGridImportMode importMode
 Import mode, determines import data format.
NvFlowGridImportStateCPU * stateCPU
 Import CPU state, captured previously with NvFlowGridImportUpdateStateCPU().
+

Detailed Description

+Parameters for grabbing import view.

Field Documentation

+ +
+
+ + + + +
NvFlowGridTextureChannel NvFlowGridImportStateCPUParams::channel
+
+
+ +

+Grid texture channel to generate import data for. +

+ +

+

+ +

+
+ + + + +
NvFlowGridImportMode NvFlowGridImportStateCPUParams::importMode
+
+
+ +

+Import mode, determines import data format. +

+ +

+

+ +

+
+ + + + +
NvFlowGridImportStateCPU* NvFlowGridImportStateCPUParams::stateCPU
+
+
+ +

+Import CPU state, captured previously with NvFlowGridImportUpdateStateCPU(). +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_material_handle.html b/docs/api/files/struct_nv_flow_grid_material_handle.html new file mode 100644 index 0000000..15f84f0 --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_material_handle.html @@ -0,0 +1,88 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridMaterialHandle Struct Reference + + + + + + + + +
+

NvFlowGridMaterialHandle Struct Reference
+ +[NvFlowGridMaterial] +

Handle provided by grid to reference materials. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + +

Data Fields

NvFlowGrid * grid
 The grid that created this material handle.
NvFlowUint64 uid
 Unique id for this material.
+

Detailed Description

+Handle provided by grid to reference materials.

Field Documentation

+ +
+
+ + + + +
NvFlowGrid* NvFlowGridMaterialHandle::grid
+
+
+ +

+The grid that created this material handle. +

+ +

+

+ +

+
+ + + + +
NvFlowUint64 NvFlowGridMaterialHandle::uid
+
+
+ +

+Unique id for this material. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_material_params.html b/docs/api/files/struct_nv_flow_grid_material_params.html new file mode 100644 index 0000000..2d5de32 --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_material_params.html @@ -0,0 +1,328 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridMaterialParams Struct Reference + + + + + + + + +
+

NvFlowGridMaterialParams Struct Reference
+ +[NvFlowGridMaterial] +

Grid material parameters. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields

float buoyancyPerTemp
 Buoyant force per unit temperature.
float burnPerTemp
 Burn amount per unit temperature above ignitionTemp.
float coolingRate
 Cooling rate, exponential.
float divergencePerBurn
 Expansion per unit burn.
NvFlowGridMaterialPerComponent fuel
 Fuel component parameters.
float fuelPerBurn
 Fuel consumed per unit burn.
float ignitionTemp
 Minimum temperature for combustion.
NvFlowGridMaterialPerComponent smoke
 Smoke component parameters.
float smokePerBurn
 Smoke increase per unit burn.
NvFlowGridMaterialPerComponent temperature
 Temperature component parameters.
float tempPerBurn
 Temperature increase per unit burn.
NvFlowGridMaterialPerComponent velocity
 Velocity component parameters.
float vorticityStrength
 Higher values increase rotation, reduce laminar flow.
float vorticityVelocityMask
 0.f means zero velocity magnitude influence on vorticity
+

Detailed Description

+Grid material parameters.

Field Documentation

+ +
+
+ + + + +
float NvFlowGridMaterialParams::buoyancyPerTemp
+
+
+ +

+Buoyant force per unit temperature. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridMaterialParams::burnPerTemp
+
+
+ +

+Burn amount per unit temperature above ignitionTemp. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridMaterialParams::coolingRate
+
+
+ +

+Cooling rate, exponential. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridMaterialParams::divergencePerBurn
+
+
+ +

+Expansion per unit burn. +

+ +

+

+ +

+
+ + + + +
NvFlowGridMaterialPerComponent NvFlowGridMaterialParams::fuel
+
+
+ +

+Fuel component parameters. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridMaterialParams::fuelPerBurn
+
+
+ +

+Fuel consumed per unit burn. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridMaterialParams::ignitionTemp
+
+
+ +

+Minimum temperature for combustion. +

+ +

+

+ +

+
+ + + + +
NvFlowGridMaterialPerComponent NvFlowGridMaterialParams::smoke
+
+
+ +

+Smoke component parameters. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridMaterialParams::smokePerBurn
+
+
+ +

+Smoke increase per unit burn. +

+ +

+

+ +

+
+ + + + +
NvFlowGridMaterialPerComponent NvFlowGridMaterialParams::temperature
+
+
+ +

+Temperature component parameters. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridMaterialParams::tempPerBurn
+
+
+ +

+Temperature increase per unit burn. +

+ +

+

+ +

+
+ + + + +
NvFlowGridMaterialPerComponent NvFlowGridMaterialParams::velocity
+
+
+ +

+Velocity component parameters. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridMaterialParams::vorticityStrength
+
+
+ +

+Higher values increase rotation, reduce laminar flow. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridMaterialParams::vorticityVelocityMask
+
+
+ +

+0.f means zero velocity magnitude influence on vorticity +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_material_per_component.html b/docs/api/files/struct_nv_flow_grid_material_per_component.html new file mode 100644 index 0000000..04ecc22 --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_material_per_component.html @@ -0,0 +1,168 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridMaterialPerComponent Struct Reference + + + + + + + + +
+

NvFlowGridMaterialPerComponent Struct Reference
+ +[NvFlowGridMaterial] +

Grid material per component parameters. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + + + + +

Data Fields

float allocThreshold
 Minimum component value magnitude that is considered relevant.
float allocWeight
 Relative importance of component value for allocation, 0.0 means not important.
float damping
 Higher values reduce component value faster (exponential decay curve).
float fade
 Fade component value rate in units / sec.
float macCormackBlendFactor
 Higher values make a sharper appearance, but with more artifacts.
float macCormackBlendThreshold
 Minimum absolute value to apply MacCormack correction. Increasing can improve performance.
+

Detailed Description

+Grid material per component parameters.

Field Documentation

+ +
+
+ + + + +
float NvFlowGridMaterialPerComponent::allocThreshold
+
+
+ +

+Minimum component value magnitude that is considered relevant. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridMaterialPerComponent::allocWeight
+
+
+ +

+Relative importance of component value for allocation, 0.0 means not important. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridMaterialPerComponent::damping
+
+
+ +

+Higher values reduce component value faster (exponential decay curve). +

+ +

+

+ +

+
+ + + + +
float NvFlowGridMaterialPerComponent::fade
+
+
+ +

+Fade component value rate in units / sec. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridMaterialPerComponent::macCormackBlendFactor
+
+
+ +

+Higher values make a sharper appearance, but with more artifacts. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridMaterialPerComponent::macCormackBlendThreshold
+
+
+ +

+Minimum absolute value to apply MacCormack correction. Increasing can improve performance. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_params.html b/docs/api/files/struct_nv_flow_grid_params.html new file mode 100644 index 0000000..e1c7c37 --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_params.html @@ -0,0 +1,148 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridParams Struct Reference + + + + + + + + +
+

NvFlowGridParams Struct Reference
+ +[NvFlowGrid] +

Parameters controlling grid behavior. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + +

Data Fields

bool bigEffectMode
 Tweaks block allocation for better big effect behavior.
float bigEffectPredictTime
 Time constant to tune big effect prediction.
NvFlowGridDebugVisFlags debugVisFlags
 Flags to control what debug visualization information is generated.
NvFlowFloat3 gravity
 Gravity vector for use by buoyancy.
bool pressureLegacyMode
 If true, run older less accurate pressure solver.
+

Detailed Description

+Parameters controlling grid behavior.

Field Documentation

+ +
+
+ + + + +
bool NvFlowGridParams::bigEffectMode
+
+
+ +

+Tweaks block allocation for better big effect behavior. +

+ +

+

+ +

+
+ + + + +
float NvFlowGridParams::bigEffectPredictTime
+
+
+ +

+Time constant to tune big effect prediction. +

+ +

+

+ +

+
+ + + + +
NvFlowGridDebugVisFlags NvFlowGridParams::debugVisFlags
+
+
+ +

+Flags to control what debug visualization information is generated. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowGridParams::gravity
+
+
+ +

+Gravity vector for use by buoyancy. +

+ +

+

+ +

+
+ + + + +
bool NvFlowGridParams::pressureLegacyMode
+
+
+ +

+If true, run older less accurate pressure solver. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_proxy_desc.html b/docs/api/files/struct_nv_flow_grid_proxy_desc.html new file mode 100644 index 0000000..01f3162 --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_proxy_desc.html @@ -0,0 +1,168 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridProxyDesc Struct Reference + + + + + + + + +
+

NvFlowGridProxyDesc Struct Reference
+ +[NvFlowGridProxy] +

Parameters need to create a grid proxy. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + + + + +

Data Fields

NvFlowContext * gridContext
 Context used to simulate grid.
NvFlowContext * gridCopyContext
 Context with copy capability on gridContext device.
NvFlowGridExport * gridExport
 GridExport to base allocation on.
NvFlowGridProxyType proxyType
 GridProxy type to create.
NvFlowContext * renderContext
 Context used to render grid.
NvFlowContext * renderCopyContext
 Context with copy capability on renderContext device.
+

Detailed Description

+Parameters need to create a grid proxy.

Field Documentation

+ +
+
+ + + + +
NvFlowContext* NvFlowGridProxyDesc::gridContext
+
+
+ +

+Context used to simulate grid. +

+ +

+

+ +

+
+ + + + +
NvFlowContext* NvFlowGridProxyDesc::gridCopyContext
+
+
+ +

+Context with copy capability on gridContext device. +

+ +

+

+ +

+
+ + + + +
NvFlowGridExport* NvFlowGridProxyDesc::gridExport
+
+
+ +

+GridExport to base allocation on. +

+ +

+

+ +

+
+ + + + +
NvFlowGridProxyType NvFlowGridProxyDesc::proxyType
+
+
+ +

+GridProxy type to create. +

+ +

+

+ +

+
+ + + + +
NvFlowContext* NvFlowGridProxyDesc::renderContext
+
+
+ +

+Context used to render grid. +

+ +

+

+ +

+
+ + + + +
NvFlowContext* NvFlowGridProxyDesc::renderCopyContext
+
+
+ +

+Context with copy capability on renderContext device. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_proxy_flush_params.html b/docs/api/files/struct_nv_flow_grid_proxy_flush_params.html new file mode 100644 index 0000000..298f26b --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_proxy_flush_params.html @@ -0,0 +1,108 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridProxyFlushParams Struct Reference + + + + + + + + +
+

NvFlowGridProxyFlushParams Struct Reference
+ +[NvFlowGridProxy] +

Parameters need to create a multi-GPU proxy. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + +

Data Fields

NvFlowContext * gridContext
 Context used to simulate grid.
NvFlowContext * gridCopyContext
 Context with copy capability on gridContext device.
NvFlowContext * renderCopyContext
 Context with copy capability on renderContext device.
+

Detailed Description

+Parameters need to create a multi-GPU proxy.

Field Documentation

+ +
+
+ + + + +
NvFlowContext* NvFlowGridProxyFlushParams::gridContext
+
+
+ +

+Context used to simulate grid. +

+ +

+

+ +

+
+ + + + +
NvFlowContext* NvFlowGridProxyFlushParams::gridCopyContext
+
+
+ +

+Context with copy capability on gridContext device. +

+ +

+

+ +

+
+ + + + +
NvFlowContext* NvFlowGridProxyFlushParams::renderCopyContext
+
+
+ +

+Context with copy capability on renderContext device. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_grid_reset_desc.html b/docs/api/files/struct_nv_flow_grid_reset_desc.html new file mode 100644 index 0000000..235c23c --- /dev/null +++ b/docs/api/files/struct_nv_flow_grid_reset_desc.html @@ -0,0 +1,88 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridResetDesc Struct Reference + + + + + + + + +
+

NvFlowGridResetDesc Struct Reference
+ +[NvFlowGrid] +

Description required to reset a NvFlowGrid. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + +

Data Fields

NvFlowFloat3 halfSize
 Initial half size of axis aligned bounding box.
NvFlowFloat3 initialLocation
 Initial location of axis aligned bounding box.
+

Detailed Description

+Description required to reset a NvFlowGrid.

Field Documentation

+ +
+
+ + + + +
NvFlowFloat3 NvFlowGridResetDesc::halfSize
+
+
+ +

+Initial half size of axis aligned bounding box. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowGridResetDesc::initialLocation
+
+
+ +

+Initial location of axis aligned bounding box. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_particle_surface_data.html b/docs/api/files/struct_nv_flow_particle_surface_data.html new file mode 100644 index 0000000..984b95e --- /dev/null +++ b/docs/api/files/struct_nv_flow_particle_surface_data.html @@ -0,0 +1,108 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowParticleSurfaceData Struct Reference + + + + + + + + +
+

NvFlowParticleSurfaceData Struct Reference
+ +[NvFlowParticleSurface] +

Particle data. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + +

Data Fields

NvFlowUint numParticles
 Number of particles in array.
const float * positions
 Array of particle positions, xyz components.
NvFlowUint positionStride
 Stride in bytes between particles.
+

Detailed Description

+Particle data.

Field Documentation

+ +
+
+ + + + +
NvFlowUint NvFlowParticleSurfaceData::numParticles
+
+
+ +

+Number of particles in array. +

+ +

+

+ +

+
+ + + + +
const float* NvFlowParticleSurfaceData::positions
+
+
+ +

+Array of particle positions, xyz components. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowParticleSurfaceData::positionStride
+
+
+ +

+Stride in bytes between particles. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_particle_surface_desc.html b/docs/api/files/struct_nv_flow_particle_surface_desc.html new file mode 100644 index 0000000..a7e804e --- /dev/null +++ b/docs/api/files/struct_nv_flow_particle_surface_desc.html @@ -0,0 +1,148 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowParticleSurfaceDesc Struct Reference + + + + + + + + +
+

NvFlowParticleSurfaceDesc Struct Reference
+ +[NvFlowParticleSurface] +

Description for creation. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + +

Data Fields

NvFlowFloat3 halfSize
 Initial half size of axis aligned bounding box.
NvFlowFloat3 initialLocation
 Initial location of axis aligned bounding box.
NvFlowUint maxParticles
 Maximum particle count for memory allocation.
float residentScale
 Fraction of virtual cells to allocate memory for.
NvFlowDim virtualDim
 Resolution of virtual address space inside of bounding box.
+

Detailed Description

+Description for creation.

Field Documentation

+ +
+
+ + + + +
NvFlowFloat3 NvFlowParticleSurfaceDesc::halfSize
+
+
+ +

+Initial half size of axis aligned bounding box. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowParticleSurfaceDesc::initialLocation
+
+
+ +

+Initial location of axis aligned bounding box. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowParticleSurfaceDesc::maxParticles
+
+
+ +

+Maximum particle count for memory allocation. +

+ +

+

+ +

+
+ + + + +
float NvFlowParticleSurfaceDesc::residentScale
+
+
+ +

+Fraction of virtual cells to allocate memory for. +

+ +

+

+ +

+
+ + + + +
NvFlowDim NvFlowParticleSurfaceDesc::virtualDim
+
+
+ +

+Resolution of virtual address space inside of bounding box. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_particle_surface_emit_params.html b/docs/api/files/struct_nv_flow_particle_surface_emit_params.html new file mode 100644 index 0000000..5ceeab7 --- /dev/null +++ b/docs/api/files/struct_nv_flow_particle_surface_emit_params.html @@ -0,0 +1,225 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowParticleSurfaceEmitParams Struct Reference + + + + + + + + +
+

NvFlowParticleSurfaceEmitParams Struct Reference
+ +[NvFlowParticleSurface] +

Parameter for surface emission. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields

float deltaTime
float fuel
 Target fuel.
float fuelCoupleRate
 Rate of correction to target, inf means instantaneous.
float smoke
 Target smoke.
float smokeCoupleRate
 Rate of correction to target, inf means instantaneous.
float temperature
 Target temperature.
float temperatureCoupleRate
 Rate of correction to target, inf means instantaneous.
NvFlowFloat3 velocityCoupleRate
 Rate of correction to target, inf means instantaneous.
NvFlowFloat3 velocityLinear
 Linear velocity, in world units, emitter direction.
+

Detailed Description

+Parameter for surface emission.

Field Documentation

+ +
+
+ + + + +
float NvFlowParticleSurfaceEmitParams::deltaTime
+
+
+ +

+ +

+

+ +

+
+ + + + +
float NvFlowParticleSurfaceEmitParams::fuel
+
+
+ +

+Target fuel. +

+ +

+

+ +

+
+ + + + +
float NvFlowParticleSurfaceEmitParams::fuelCoupleRate
+
+
+ +

+Rate of correction to target, inf means instantaneous. +

+ +

+

+ +

+
+ + + + +
float NvFlowParticleSurfaceEmitParams::smoke
+
+
+ +

+Target smoke. +

+ +

+

+ +

+
+ + + + +
float NvFlowParticleSurfaceEmitParams::smokeCoupleRate
+
+
+ +

+Rate of correction to target, inf means instantaneous. +

+ +

+

+ +

+
+ + + + +
float NvFlowParticleSurfaceEmitParams::temperature
+
+
+ +

+Target temperature. +

+ +

+

+ +

+
+ + + + +
float NvFlowParticleSurfaceEmitParams::temperatureCoupleRate
+
+
+ +

+Rate of correction to target, inf means instantaneous. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowParticleSurfaceEmitParams::velocityCoupleRate
+
+
+ +

+Rate of correction to target, inf means instantaneous. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowParticleSurfaceEmitParams::velocityLinear
+
+
+ +

+Linear velocity, in world units, emitter direction. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_particle_surface_params.html b/docs/api/files/struct_nv_flow_particle_surface_params.html new file mode 100644 index 0000000..02a2349 --- /dev/null +++ b/docs/api/files/struct_nv_flow_particle_surface_params.html @@ -0,0 +1,108 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowParticleSurfaceParams Struct Reference + + + + + + + + +
+

NvFlowParticleSurfaceParams Struct Reference
+ +[NvFlowParticleSurface] +

Parameters for update. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + +

Data Fields

bool separableSmoothing
 If true, use separable convolution for smoothing.
float smoothRadius
 Radius of smoothing kernel.
float surfaceThreshold
 Threshold used to define isosurface.
+

Detailed Description

+Parameters for update.

Field Documentation

+ +
+
+ + + + +
bool NvFlowParticleSurfaceParams::separableSmoothing
+
+
+ +

+If true, use separable convolution for smoothing. +

+ +

+

+ +

+
+ + + + +
float NvFlowParticleSurfaceParams::smoothRadius
+
+
+ +

+Radius of smoothing kernel. +

+ +

+

+ +

+
+ + + + +
float NvFlowParticleSurfaceParams::surfaceThreshold
+
+
+ +

+Threshold used to define isosurface. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_query_time.html b/docs/api/files/struct_nv_flow_query_time.html new file mode 100644 index 0000000..b20a2a5 --- /dev/null +++ b/docs/api/files/struct_nv_flow_query_time.html @@ -0,0 +1,65 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowQueryTime Struct Reference + + + + + + + + +
+

NvFlowQueryTime Struct Reference
+ +[NvFlowGrid] +

CPU/GPU timing info. +More... +

+#include <NvFlow.h> +

+ + + + + +

Data Fields

float simulation
+

Detailed Description

+CPU/GPU timing info.

Field Documentation

+ +
+
+ + + + +
float NvFlowQueryTime::simulation
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_render_material_handle.html b/docs/api/files/struct_nv_flow_render_material_handle.html new file mode 100644 index 0000000..e9b3149 --- /dev/null +++ b/docs/api/files/struct_nv_flow_render_material_handle.html @@ -0,0 +1,88 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowRenderMaterialHandle Struct Reference + + + + + + + + +
+

NvFlowRenderMaterialHandle Struct Reference
+ +[NvFlowRenderMaterial] +

A handle to a volume render material. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + +

Data Fields

NvFlowRenderMaterialPool * pool
 The pool that created this material.
NvFlowUint64 uid
 Unique id for the render material.
+

Detailed Description

+A handle to a volume render material.

Field Documentation

+ +
+
+ + + + +
NvFlowRenderMaterialPool* NvFlowRenderMaterialHandle::pool
+
+
+ +

+The pool that created this material. +

+ +

+

+ +

+
+ + + + +
NvFlowUint64 NvFlowRenderMaterialHandle::uid
+
+
+ +

+Unique id for the render material. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_render_material_params.html b/docs/api/files/struct_nv_flow_render_material_params.html new file mode 100644 index 0000000..3af5bd0 --- /dev/null +++ b/docs/api/files/struct_nv_flow_render_material_params.html @@ -0,0 +1,248 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowRenderMaterialParams Struct Reference + + + + + + + + +
+

NvFlowRenderMaterialParams Struct Reference
+ +[NvFlowRenderMaterial] +

Per material parameters for Flow grid rendering. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields

float additiveFactor
 1.0 makes material blend fully additive
float alphaBias
 Offsets alpha before saturate(alpha).
NvFlowFloat4 alphaCompMask
 Component mask to control which channel(s) modulation the alpha.
float alphaScale
 Global alpha scale for adjust net opacity without color map changes, applied after saturate(alpha).
NvFlowFloat4 colorMapCompMask
 Component mask for colormap, control what channel drives color map X axis;.
float colorMapMaxX
 Maximum value on the x channel (typically temperature), maps to colorMap u = 1.0.
float colorMapMinX
 Minimum value on the x channel (typically temperature), maps to colorMap u = 0.0.
float intensityBias
 Offsets intensity before modulating color.
NvFlowFloat4 intensityCompMask
 Component mask to control which channel(s) modulates the intensity.
NvFlowGridMaterialHandle material
 Grid material to align these parameters with.
+

Detailed Description

+Per material parameters for Flow grid rendering.

Field Documentation

+ +
+
+ + + + +
float NvFlowRenderMaterialParams::additiveFactor
+
+
+ +

+1.0 makes material blend fully additive +

+ +

+

+ +

+
+ + + + +
float NvFlowRenderMaterialParams::alphaBias
+
+
+ +

+Offsets alpha before saturate(alpha). +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4 NvFlowRenderMaterialParams::alphaCompMask
+
+
+ +

+Component mask to control which channel(s) modulation the alpha. +

+ +

+

+ +

+
+ + + + +
float NvFlowRenderMaterialParams::alphaScale
+
+
+ +

+Global alpha scale for adjust net opacity without color map changes, applied after saturate(alpha). +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4 NvFlowRenderMaterialParams::colorMapCompMask
+
+
+ +

+Component mask for colormap, control what channel drives color map X axis;. +

+ +

+

+ +

+
+ + + + +
float NvFlowRenderMaterialParams::colorMapMaxX
+
+
+ +

+Maximum value on the x channel (typically temperature), maps to colorMap u = 1.0. +

+ +

+

+ +

+
+ + + + +
float NvFlowRenderMaterialParams::colorMapMinX
+
+
+ +

+Minimum value on the x channel (typically temperature), maps to colorMap u = 0.0. +

+ +

+

+ +

+
+ + + + +
float NvFlowRenderMaterialParams::intensityBias
+
+
+ +

+Offsets intensity before modulating color. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4 NvFlowRenderMaterialParams::intensityCompMask
+
+
+ +

+Component mask to control which channel(s) modulates the intensity. +

+ +

+

+ +

+
+ + + + +
NvFlowGridMaterialHandle NvFlowRenderMaterialParams::material
+
+
+ +

+Grid material to align these parameters with. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_render_material_pool_desc.html b/docs/api/files/struct_nv_flow_render_material_pool_desc.html new file mode 100644 index 0000000..dd52cd7 --- /dev/null +++ b/docs/api/files/struct_nv_flow_render_material_pool_desc.html @@ -0,0 +1,68 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowRenderMaterialPoolDesc Struct Reference + + + + + + + + +
+

NvFlowRenderMaterialPoolDesc Struct Reference
+ +[NvFlowRenderMaterial] +

Description necessary to create render material. +More... +

+#include <NvFlow.h> +

+ + + + + + +

Data Fields

NvFlowUint colorMapResolution
 Dimension of 1D texture used to store color map, 64 is a good default.
+

Detailed Description

+Description necessary to create render material.

Field Documentation

+ +
+
+ + + + +
NvFlowUint NvFlowRenderMaterialPoolDesc::colorMapResolution
+
+
+ +

+Dimension of 1D texture used to store color map, 64 is a good default. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_render_target_view_desc_d3_d11.html b/docs/api/files/struct_nv_flow_render_target_view_desc_d3_d11.html new file mode 100644 index 0000000..37acd92 --- /dev/null +++ b/docs/api/files/struct_nv_flow_render_target_view_desc_d3_d11.html @@ -0,0 +1,78 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowRenderTargetViewDescD3D11 Struct Reference + + + + + + + + +
+

NvFlowRenderTargetViewDescD3D11 Struct Reference
+ +[NvFlowContextD3D11] +

#include <NvFlowContextD3D11.h> +

+ + + + + + + +

Data Fields

ID3D11RenderTargetView * rtv
D3D11_VIEWPORT viewport
+

Field Documentation

+ +
+
+ + + + +
ID3D11RenderTargetView* NvFlowRenderTargetViewDescD3D11::rtv
+
+
+ +

+ +

+

+ +

+
+ + + + +
D3D11_VIEWPORT NvFlowRenderTargetViewDescD3D11::viewport
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_render_target_view_desc_d3_d12.html b/docs/api/files/struct_nv_flow_render_target_view_desc_d3_d12.html new file mode 100644 index 0000000..68e290a --- /dev/null +++ b/docs/api/files/struct_nv_flow_render_target_view_desc_d3_d12.html @@ -0,0 +1,146 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowRenderTargetViewDescD3D12 Struct Reference + + + + + + + + +
+

NvFlowRenderTargetViewDescD3D12 Struct Reference
+ +[NvFlowContextD3D12] +

#include <NvFlowContextD3D12.h> +

+ + + + + + + + + + + + + + + +

Data Fields

D3D12_RESOURCE_STATES currentState
ID3D12Resource * resource
D3D12_RENDER_TARGET_VIEW_DESC rtvDesc
D3D12_CPU_DESCRIPTOR_HANDLE rtvHandle
D3D12_RECT scissor
D3D12_VIEWPORT viewport
+

Field Documentation

+ +
+
+ + + + +
D3D12_RESOURCE_STATES NvFlowRenderTargetViewDescD3D12::currentState
+
+
+ +

+ +

+

+ +

+
+ + + + +
ID3D12Resource* NvFlowRenderTargetViewDescD3D12::resource
+
+
+ +

+ +

+

+ +

+
+ + + + +
D3D12_RENDER_TARGET_VIEW_DESC NvFlowRenderTargetViewDescD3D12::rtvDesc
+
+
+ +

+ +

+

+ +

+
+ + + + +
D3D12_CPU_DESCRIPTOR_HANDLE NvFlowRenderTargetViewDescD3D12::rtvHandle
+
+
+ +

+ +

+

+ +

+
+ + + + +
D3D12_RECT NvFlowRenderTargetViewDescD3D12::scissor
+
+
+ +

+ +

+

+ +

+
+ + + + +
D3D12_VIEWPORT NvFlowRenderTargetViewDescD3D12::viewport
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_resource_r_w_view_desc_d3_d11.html b/docs/api/files/struct_nv_flow_resource_r_w_view_desc_d3_d11.html new file mode 100644 index 0000000..0d3f0ed --- /dev/null +++ b/docs/api/files/struct_nv_flow_resource_r_w_view_desc_d3_d11.html @@ -0,0 +1,78 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowResourceRWViewDescD3D11 Struct Reference + + + + + + + + +
+

NvFlowResourceRWViewDescD3D11 Struct Reference
+ +[NvFlowContextD3D11] +

#include <NvFlowContextD3D11.h> +

+ + + + + + + +

Data Fields

NvFlowResourceViewDescD3D11 resourceView
ID3D11UnorderedAccessView * uav
+

Field Documentation

+ +
+
+ + + + +
NvFlowResourceViewDescD3D11 NvFlowResourceRWViewDescD3D11::resourceView
+
+
+ +

+ +

+

+ +

+
+ + + + +
ID3D11UnorderedAccessView* NvFlowResourceRWViewDescD3D11::uav
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_resource_r_w_view_desc_d3_d12.html b/docs/api/files/struct_nv_flow_resource_r_w_view_desc_d3_d12.html new file mode 100644 index 0000000..893a80e --- /dev/null +++ b/docs/api/files/struct_nv_flow_resource_r_w_view_desc_d3_d12.html @@ -0,0 +1,95 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowResourceRWViewDescD3D12 Struct Reference + + + + + + + + +
+

NvFlowResourceRWViewDescD3D12 Struct Reference
+ +[NvFlowContextD3D12] +

#include <NvFlowContextD3D12.h> +

+ + + + + + + + + +

Data Fields

NvFlowResourceViewDescD3D12 resourceView
D3D12_UNORDERED_ACCESS_VIEW_DESC uavDesc
D3D12_CPU_DESCRIPTOR_HANDLE uavHandle
+

Field Documentation

+ +
+
+ + + + +
NvFlowResourceViewDescD3D12 NvFlowResourceRWViewDescD3D12::resourceView
+
+
+ +

+ +

+

+ +

+
+ + + + +
D3D12_UNORDERED_ACCESS_VIEW_DESC NvFlowResourceRWViewDescD3D12::uavDesc
+
+
+ +

+ +

+

+ +

+
+ + + + +
D3D12_CPU_DESCRIPTOR_HANDLE NvFlowResourceRWViewDescD3D12::uavHandle
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_resource_view_desc_d3_d11.html b/docs/api/files/struct_nv_flow_resource_view_desc_d3_d11.html new file mode 100644 index 0000000..be39f31 --- /dev/null +++ b/docs/api/files/struct_nv_flow_resource_view_desc_d3_d11.html @@ -0,0 +1,61 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowResourceViewDescD3D11 Struct Reference + + + + + + + + +
+

NvFlowResourceViewDescD3D11 Struct Reference
+ +[NvFlowContextD3D11] +

#include <NvFlowContextD3D11.h> +

+ + + + + +

Data Fields

ID3D11ShaderResourceView * srv
+

Field Documentation

+ +
+
+ + + + +
ID3D11ShaderResourceView* NvFlowResourceViewDescD3D11::srv
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_resource_view_desc_d3_d12.html b/docs/api/files/struct_nv_flow_resource_view_desc_d3_d12.html new file mode 100644 index 0000000..8ba24de --- /dev/null +++ b/docs/api/files/struct_nv_flow_resource_view_desc_d3_d12.html @@ -0,0 +1,112 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowResourceViewDescD3D12 Struct Reference + + + + + + + + +
+

NvFlowResourceViewDescD3D12 Struct Reference
+ +[NvFlowContextD3D12] +

#include <NvFlowContextD3D12.h> +

+ + + + + + + + + + + +

Data Fields

D3D12_RESOURCE_STATES * currentState
ID3D12Resource * resource
D3D12_SHADER_RESOURCE_VIEW_DESC srvDesc
D3D12_CPU_DESCRIPTOR_HANDLE srvHandle
+

Field Documentation

+ +
+
+ + + + +
D3D12_RESOURCE_STATES* NvFlowResourceViewDescD3D12::currentState
+
+
+ +

+ +

+

+ +

+
+ + + + +
ID3D12Resource* NvFlowResourceViewDescD3D12::resource
+
+
+ +

+ +

+

+ +

+
+ + + + +
D3D12_SHADER_RESOURCE_VIEW_DESC NvFlowResourceViewDescD3D12::srvDesc
+
+
+ +

+ +

+

+ +

+
+ + + + +
D3D12_CPU_DESCRIPTOR_HANDLE NvFlowResourceViewDescD3D12::srvHandle
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_s_d_f_gen_desc.html b/docs/api/files/struct_nv_flow_s_d_f_gen_desc.html new file mode 100644 index 0000000..35a8bbc --- /dev/null +++ b/docs/api/files/struct_nv_flow_s_d_f_gen_desc.html @@ -0,0 +1,68 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowSDFGenDesc Struct Reference + + + + + + + + +
+

NvFlowSDFGenDesc Struct Reference
+ +[NvFlowSDFGenerator] +

Description required for creating a signed distance field generator. +More... +

+#include <NvFlow.h> +

+ + + + + + +

Data Fields

NvFlowDim resolution
 Resolution of 3D texture storing signed distance field.
+

Detailed Description

+Description required for creating a signed distance field generator.

Field Documentation

+ +
+
+ + + + +
NvFlowDim NvFlowSDFGenDesc::resolution
+
+
+ +

+Resolution of 3D texture storing signed distance field. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_s_d_f_gen_mesh_params.html b/docs/api/files/struct_nv_flow_s_d_f_gen_mesh_params.html new file mode 100644 index 0000000..9c94730 --- /dev/null +++ b/docs/api/files/struct_nv_flow_s_d_f_gen_mesh_params.html @@ -0,0 +1,248 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowSDFGenMeshParams Struct Reference + + + + + + + + +
+

NvFlowSDFGenMeshParams Struct Reference
+ +[NvFlowSDFGenerator] +

Simple mesh description. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields

NvFlowDepthStencilView * depthStencilView
 Depth stencil view to restore after voxelize work, lighter than Flow context push/pop.
NvFlowUint * indices
 Array of indices.
NvFlowFloat4x4 modelMatrix
 transforms from model space to SDF NDC space
float * normals
 Array of normals, stored in nx, ny, nz order.
NvFlowUint normalStride
 The distance between the beginning of one normal to the beginning of the next normal in array, in bytes.
NvFlowUint numIndices
 Numbers of indices in triangle mesh.
NvFlowUint numVertices
 Numbers of vertices in triangle mesh.
float * positions
 Array of positions, stored in x, y, z order.
NvFlowUint positionStride
 The distance between the beginning of one position to the beginning of the next position in array, in bytes.
NvFlowRenderTargetView * renderTargetView
 Render target view to restore after voxelize work, lighter than Flow context push/pop.
+

Detailed Description

+Simple mesh description.

Field Documentation

+ +
+
+ + + + +
NvFlowDepthStencilView* NvFlowSDFGenMeshParams::depthStencilView
+
+
+ +

+Depth stencil view to restore after voxelize work, lighter than Flow context push/pop. +

+ +

+

+ +

+
+ + + + +
NvFlowUint* NvFlowSDFGenMeshParams::indices
+
+
+ +

+Array of indices. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4x4 NvFlowSDFGenMeshParams::modelMatrix
+
+
+ +

+transforms from model space to SDF NDC space +

+ +

+

+ +

+
+ + + + +
float* NvFlowSDFGenMeshParams::normals
+
+
+ +

+Array of normals, stored in nx, ny, nz order. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowSDFGenMeshParams::normalStride
+
+
+ +

+The distance between the beginning of one normal to the beginning of the next normal in array, in bytes. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowSDFGenMeshParams::numIndices
+
+
+ +

+Numbers of indices in triangle mesh. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowSDFGenMeshParams::numVertices
+
+
+ +

+Numbers of vertices in triangle mesh. +

+ +

+

+ +

+
+ + + + +
float* NvFlowSDFGenMeshParams::positions
+
+
+ +

+Array of positions, stored in x, y, z order. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowSDFGenMeshParams::positionStride
+
+
+ +

+The distance between the beginning of one position to the beginning of the next position in array, in bytes. +

+ +

+

+ +

+
+ + + + +
NvFlowRenderTargetView* NvFlowSDFGenMeshParams::renderTargetView
+
+
+ +

+Render target view to restore after voxelize work, lighter than Flow context push/pop. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_shader_linear_params.html b/docs/api/files/struct_nv_flow_shader_linear_params.html new file mode 100644 index 0000000..0800ffb --- /dev/null +++ b/docs/api/files/struct_nv_flow_shader_linear_params.html @@ -0,0 +1,235 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowShaderLinearParams Struct Reference + + + + + + + + +
+

NvFlowShaderLinearParams Struct Reference
+ +[NvFlowContext] +

Parameters for shaders using the linear format (linear interpolation). +More... +

+#include <NvFlowShader.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields

NvFlowUint4 blockDim
NvFlowUint4 blockDimBits
NvFlowFloat4 blockDimInv
NvFlowFloat4 dimInv
NvFlowUint4 gridDim
NvFlowUint4 isVTR
NvFlowUint4 linearBlockDim
NvFlowUint4 linearBlockOffset
NvFlowUint4 poolGridDim
NvFlowFloat4 vdim
NvFlowFloat4 vdimInv
+

Detailed Description

+Parameters for shaders using the linear format (linear interpolation).

Field Documentation

+ +
+
+ + + + +
NvFlowUint4 NvFlowShaderLinearParams::blockDim
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint4 NvFlowShaderLinearParams::blockDimBits
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4 NvFlowShaderLinearParams::blockDimInv
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4 NvFlowShaderLinearParams::dimInv
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint4 NvFlowShaderLinearParams::gridDim
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint4 NvFlowShaderLinearParams::isVTR
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint4 NvFlowShaderLinearParams::linearBlockDim
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint4 NvFlowShaderLinearParams::linearBlockOffset
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint4 NvFlowShaderLinearParams::poolGridDim
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4 NvFlowShaderLinearParams::vdim
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4 NvFlowShaderLinearParams::vdimInv
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_shader_point_params.html b/docs/api/files/struct_nv_flow_shader_point_params.html new file mode 100644 index 0000000..90dd88c --- /dev/null +++ b/docs/api/files/struct_nv_flow_shader_point_params.html @@ -0,0 +1,133 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowShaderPointParams Struct Reference + + + + + + + + +
+

NvFlowShaderPointParams Struct Reference
+ +[NvFlowContext] +

Parameters for shaders using the point format (no linear interpolation). +More... +

+#include <NvFlowShader.h> +

+ + + + + + + + + + + + + +

Data Fields

NvFlowUint4 blockDim
NvFlowUint4 blockDimBits
NvFlowUint4 gridDim
NvFlowUint4 isVTR
NvFlowUint4 poolGridDim
+

Detailed Description

+Parameters for shaders using the point format (no linear interpolation).

Field Documentation

+ +
+
+ + + + +
NvFlowUint4 NvFlowShaderPointParams::blockDim
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint4 NvFlowShaderPointParams::blockDimBits
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint4 NvFlowShaderPointParams::gridDim
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint4 NvFlowShaderPointParams::isVTR
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint4 NvFlowShaderPointParams::poolGridDim
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_shape_desc_box.html b/docs/api/files/struct_nv_flow_shape_desc_box.html new file mode 100644 index 0000000..4208bf6 --- /dev/null +++ b/docs/api/files/struct_nv_flow_shape_desc_box.html @@ -0,0 +1,68 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowShapeDescBox Struct Reference + + + + + + + + +
+

NvFlowShapeDescBox Struct Reference
+ +[NvFlowShape] +

Description of a box. +More... +

+#include <NvFlow.h> +

+ + + + + + +

Data Fields

NvFlowFloat3 halfSize
 HalfSize in local space.
+

Detailed Description

+Description of a box.

Field Documentation

+ +
+
+ + + + +
NvFlowFloat3 NvFlowShapeDescBox::halfSize
+
+
+ +

+HalfSize in local space. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_shape_desc_capsule.html b/docs/api/files/struct_nv_flow_shape_desc_capsule.html new file mode 100644 index 0000000..30b7fcd --- /dev/null +++ b/docs/api/files/struct_nv_flow_shape_desc_capsule.html @@ -0,0 +1,88 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowShapeDescCapsule Struct Reference + + + + + + + + +
+

NvFlowShapeDescCapsule Struct Reference
+ +[NvFlowShape] +

Description of a capsule. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + +

Data Fields

float length
 Length in local space on x axis.
float radius
 Radius in local space.
+

Detailed Description

+Description of a capsule.

Field Documentation

+ +
+
+ + + + +
float NvFlowShapeDescCapsule::length
+
+
+ +

+Length in local space on x axis. +

+ +

+

+ +

+
+ + + + +
float NvFlowShapeDescCapsule::radius
+
+
+ +

+Radius in local space. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_shape_desc_plane.html b/docs/api/files/struct_nv_flow_shape_desc_plane.html new file mode 100644 index 0000000..6c53363 --- /dev/null +++ b/docs/api/files/struct_nv_flow_shape_desc_plane.html @@ -0,0 +1,88 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowShapeDescPlane Struct Reference + + + + + + + + +
+

NvFlowShapeDescPlane Struct Reference
+ +[NvFlowShape] +

Description of a plane. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + +

Data Fields

float distance
 Shortest signed distance from the origin to the plane in local space.
NvFlowFloat3 normal
 Normal vector of the plane in local space.
+

Detailed Description

+Description of a plane.

Field Documentation

+ +
+
+ + + + +
float NvFlowShapeDescPlane::distance
+
+
+ +

+Shortest signed distance from the origin to the plane in local space. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat3 NvFlowShapeDescPlane::normal
+
+
+ +

+Normal vector of the plane in local space. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_shape_desc_s_d_f.html b/docs/api/files/struct_nv_flow_shape_desc_s_d_f.html new file mode 100644 index 0000000..f143be5 --- /dev/null +++ b/docs/api/files/struct_nv_flow_shape_desc_s_d_f.html @@ -0,0 +1,68 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowShapeDescSDF Struct Reference + + + + + + + + +
+

NvFlowShapeDescSDF Struct Reference
+ +[NvFlowShape] +

Description of a signed distance field shape. +More... +

+#include <NvFlow.h> +

+ + + + + + +

Data Fields

NvFlowUint sdfOffset
 Offset in number of SDFs.
+

Detailed Description

+Description of a signed distance field shape.

Field Documentation

+ +
+
+ + + + +
NvFlowUint NvFlowShapeDescSDF::sdfOffset
+
+
+ +

+Offset in number of SDFs. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_shape_desc_sphere.html b/docs/api/files/struct_nv_flow_shape_desc_sphere.html new file mode 100644 index 0000000..4294b16 --- /dev/null +++ b/docs/api/files/struct_nv_flow_shape_desc_sphere.html @@ -0,0 +1,68 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowShapeDescSphere Struct Reference + + + + + + + + +
+

NvFlowShapeDescSphere Struct Reference
+ +[NvFlowShape] +

Desription of a sphere. +More... +

+#include <NvFlow.h> +

+ + + + + + +

Data Fields

float radius
 Radius in local space.
+

Detailed Description

+Desription of a sphere.

Field Documentation

+ +
+
+ + + + +
float NvFlowShapeDescSphere::radius
+
+
+ +

+Radius in local space. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_shape_s_d_f_data.html b/docs/api/files/struct_nv_flow_shape_s_d_f_data.html new file mode 100644 index 0000000..6bc1fe3 --- /dev/null +++ b/docs/api/files/struct_nv_flow_shape_s_d_f_data.html @@ -0,0 +1,128 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowShapeSDFData Struct Reference + + + + + + + + +
+

NvFlowShapeSDFData Struct Reference
+ +[NvFlowShape] +

Required information for writing to a CPU mapped signed distance field. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + +

Data Fields

float * data
 Pointer to mapped data.
NvFlowUint depthPitch
 Depth pitch in floats.
NvFlowDim dim
 Dimension of the sdf texture.
NvFlowUint rowPitch
 Row pitch in floats.
+

Detailed Description

+Required information for writing to a CPU mapped signed distance field.

Field Documentation

+ +
+
+ + + + +
float* NvFlowShapeSDFData::data
+
+
+ +

+Pointer to mapped data. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowShapeSDFData::depthPitch
+
+
+ +

+Depth pitch in floats. +

+ +

+

+ +

+
+ + + + +
NvFlowDim NvFlowShapeSDFData::dim
+
+
+ +

+Dimension of the sdf texture. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowShapeSDFData::rowPitch
+
+
+ +

+Row pitch in floats. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_shape_s_d_f_desc.html b/docs/api/files/struct_nv_flow_shape_s_d_f_desc.html new file mode 100644 index 0000000..15aa920 --- /dev/null +++ b/docs/api/files/struct_nv_flow_shape_s_d_f_desc.html @@ -0,0 +1,68 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowShapeSDFDesc Struct Reference + + + + + + + + +
+

NvFlowShapeSDFDesc Struct Reference
+ +[NvFlowShape] +

Description required to create a signed distance field object. +More... +

+#include <NvFlow.h> +

+ + + + + + +

Data Fields

NvFlowDim resolution
 The resolution of the 3D texture used to store the signed distance field.
+

Detailed Description

+Description required to create a signed distance field object.

Field Documentation

+ +
+
+ + + + +
NvFlowDim NvFlowShapeSDFDesc::resolution
+
+
+ +

+The resolution of the 3D texture used to store the signed distance field. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_support.html b/docs/api/files/struct_nv_flow_support.html new file mode 100644 index 0000000..d4fa889 --- /dev/null +++ b/docs/api/files/struct_nv_flow_support.html @@ -0,0 +1,68 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowSupport Struct Reference + + + + + + + + +
+

NvFlowSupport Struct Reference
+ +[NvFlowGrid] +

Description of feature support on the queried Flow context GPU. +More... +

+#include <NvFlow.h> +

+ + + + + + +

Data Fields

bool supportsVTR
 True if volume tiled resources are supported.
+

Detailed Description

+Description of feature support on the queried Flow context GPU.

Field Documentation

+ +
+
+ + + + +
bool NvFlowSupport::supportsVTR
+
+
+ +

+True if volume tiled resources are supported. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_uint2.html b/docs/api/files/struct_nv_flow_uint2.html new file mode 100644 index 0000000..8e7d7ef --- /dev/null +++ b/docs/api/files/struct_nv_flow_uint2.html @@ -0,0 +1,75 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowUint2 Struct Reference + + + + + + + + +
+

NvFlowUint2 Struct Reference

#include <NvFlowTypes.h> +

+ + + + + + + +

Data Fields

NvFlowUint x
NvFlowUint y
+

Field Documentation

+ +
+
+ + + + +
NvFlowUint NvFlowUint2::x
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowUint2::y
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_uint3.html b/docs/api/files/struct_nv_flow_uint3.html new file mode 100644 index 0000000..40a6ca0 --- /dev/null +++ b/docs/api/files/struct_nv_flow_uint3.html @@ -0,0 +1,92 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowUint3 Struct Reference + + + + + + + + +
+

NvFlowUint3 Struct Reference

#include <NvFlowTypes.h> +

+ + + + + + + + + +

Data Fields

NvFlowUint x
NvFlowUint y
NvFlowUint z
+

Field Documentation

+ +
+
+ + + + +
NvFlowUint NvFlowUint3::x
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowUint3::y
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowUint3::z
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_uint4.html b/docs/api/files/struct_nv_flow_uint4.html new file mode 100644 index 0000000..8e33b10 --- /dev/null +++ b/docs/api/files/struct_nv_flow_uint4.html @@ -0,0 +1,109 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowUint4 Struct Reference + + + + + + + + +
+

NvFlowUint4 Struct Reference

#include <NvFlowTypes.h> +

+ + + + + + + + + + + +

Data Fields

NvFlowUint w
NvFlowUint x
NvFlowUint y
NvFlowUint z
+

Field Documentation

+ +
+
+ + + + +
NvFlowUint NvFlowUint4::w
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowUint4::x
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowUint4::y
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowUint4::z
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_volume_lighting_params.html b/docs/api/files/struct_nv_flow_volume_lighting_params.html new file mode 100644 index 0000000..4608452 --- /dev/null +++ b/docs/api/files/struct_nv_flow_volume_lighting_params.html @@ -0,0 +1,108 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowVolumeLightingParams Struct Reference + + + + + + + + +
+

NvFlowVolumeLightingParams Struct Reference
+ +[NvFlowVolumeRender] +

Parameters for Flow grid lighting. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + +

Data Fields

NvFlowRenderMaterialPool * materialPool
 Pool of materials to look for matches to GridMaterials.
NvFlowGridTextureChannel renderChannel
 GridExport channel to render.
NvFlowVolumeRenderMode renderMode
 Render mode, see NvFlowVolumeRenderMode.
+

Detailed Description

+Parameters for Flow grid lighting.

Field Documentation

+ +
+
+ + + + +
NvFlowRenderMaterialPool* NvFlowVolumeLightingParams::materialPool
+
+
+ +

+Pool of materials to look for matches to GridMaterials. +

+ +

+

+ +

+
+ + + + +
NvFlowGridTextureChannel NvFlowVolumeLightingParams::renderChannel
+
+
+ +

+GridExport channel to render. +

+ +

+

+ +

+
+ + + + +
NvFlowVolumeRenderMode NvFlowVolumeLightingParams::renderMode
+
+
+ +

+Render mode, see NvFlowVolumeRenderMode. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_volume_render_desc.html b/docs/api/files/struct_nv_flow_volume_render_desc.html new file mode 100644 index 0000000..c35ea00 --- /dev/null +++ b/docs/api/files/struct_nv_flow_volume_render_desc.html @@ -0,0 +1,68 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowVolumeRenderDesc Struct Reference + + + + + + + + +
+

NvFlowVolumeRenderDesc Struct Reference
+ +[NvFlowVolumeRender] +

Description needed to a create a volume render object. +More... +

+#include <NvFlow.h> +

+ + + + + + +

Data Fields

NvFlowGridExport * gridExport
 Grid export, for memory allocation.
+

Detailed Description

+Description needed to a create a volume render object.

Field Documentation

+ +
+
+ + + + +
NvFlowGridExport* NvFlowVolumeRenderDesc::gridExport
+
+
+ +

+Grid export, for memory allocation. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_volume_render_l_m_s_params.html b/docs/api/files/struct_nv_flow_volume_render_l_m_s_params.html new file mode 100644 index 0000000..e4c458a --- /dev/null +++ b/docs/api/files/struct_nv_flow_volume_render_l_m_s_params.html @@ -0,0 +1,264 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowVolumeRenderLMSParams Struct Reference + + + + + + + + +
+

NvFlowVolumeRenderLMSParams Struct Reference
+ +[NvFlowVolumeRender] +

Parameters for VRWorks lens matched shading rendering. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields

bool enabled
 If true, app render target is assumed lens matched shading.
float nonLMSHeight
 The render target height if lens matched shading was disabled.
float nonLMSWidth
 The render target width if lens matched shading was disabled.
float sizeDown
float sizeLeft
float sizeRight
float sizeUp
NvFlowVolumeRenderViewport viewport
 Single viewport representing the entire region to composite against.
float warpDown
float warpLeft
float warpRight
float warpUp
+

Detailed Description

+Parameters for VRWorks lens matched shading rendering.

Field Documentation

+ +
+
+ + + + +
bool NvFlowVolumeRenderLMSParams::enabled
+
+
+ +

+If true, app render target is assumed lens matched shading. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderLMSParams::nonLMSHeight
+
+
+ +

+The render target height if lens matched shading was disabled. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderLMSParams::nonLMSWidth
+
+
+ +

+The render target width if lens matched shading was disabled. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderLMSParams::sizeDown
+
+
+ +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderLMSParams::sizeLeft
+
+
+ +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderLMSParams::sizeRight
+
+
+ +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderLMSParams::sizeUp
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowVolumeRenderViewport NvFlowVolumeRenderLMSParams::viewport
+
+
+ +

+Single viewport representing the entire region to composite against. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderLMSParams::warpDown
+
+
+ +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderLMSParams::warpLeft
+
+
+ +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderLMSParams::warpRight
+
+
+ +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderLMSParams::warpUp
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_volume_render_multi_res_params.html b/docs/api/files/struct_nv_flow_volume_render_multi_res_params.html new file mode 100644 index 0000000..184c026 --- /dev/null +++ b/docs/api/files/struct_nv_flow_volume_render_multi_res_params.html @@ -0,0 +1,248 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowVolumeRenderMultiResParams Struct Reference + + + + + + + + +
+

NvFlowVolumeRenderMultiResParams Struct Reference
+ +[NvFlowVolumeRender] +

Parameters for VRWorks multires rendering. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields

float centerHeight
 Height of central viewport, ranging 0.01..1, where 1 is full orignal viewport height.
float centerWidth
 Width of central viewport, ranging 0.01..1, where 1 is full orignal viewport width.
float centerX
 X location of central viewport, ranging 0..1, where 0.5 is the center of the screen.
float centerY
 Y location of central viewport, ranging 0..1, where 0.5 is the center of the screen.
float densityScaleX [3]
 Pixel density scale factors: how much the linear pixel density is scaled within each column (1.0 = full density).
float densityScaleY [3]
 Pixel density scale factors: how much the linear pixel density is scaled within each row (1.0 = full density).
bool enabled
 If true, app render target is assumed multiRes.
float nonMultiResHeight
 The render target height if multires was disabled.
float nonMultiResWidth
 The render target width if multires was disabled.
NvFlowVolumeRenderViewport viewport
 Single viewport representing the entire region to composite against.
+

Detailed Description

+Parameters for VRWorks multires rendering.

Field Documentation

+ +
+
+ + + + +
float NvFlowVolumeRenderMultiResParams::centerHeight
+
+
+ +

+Height of central viewport, ranging 0.01..1, where 1 is full orignal viewport height. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderMultiResParams::centerWidth
+
+
+ +

+Width of central viewport, ranging 0.01..1, where 1 is full orignal viewport width. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderMultiResParams::centerX
+
+
+ +

+X location of central viewport, ranging 0..1, where 0.5 is the center of the screen. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderMultiResParams::centerY
+
+
+ +

+Y location of central viewport, ranging 0..1, where 0.5 is the center of the screen. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderMultiResParams::densityScaleX[3]
+
+
+ +

+Pixel density scale factors: how much the linear pixel density is scaled within each column (1.0 = full density). +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderMultiResParams::densityScaleY[3]
+
+
+ +

+Pixel density scale factors: how much the linear pixel density is scaled within each row (1.0 = full density). +

+ +

+

+ +

+
+ + + + +
bool NvFlowVolumeRenderMultiResParams::enabled
+
+
+ +

+If true, app render target is assumed multiRes. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderMultiResParams::nonMultiResHeight
+
+
+ +

+The render target height if multires was disabled. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderMultiResParams::nonMultiResWidth
+
+
+ +

+The render target width if multires was disabled. +

+ +

+

+ +

+
+ + + + +
NvFlowVolumeRenderViewport NvFlowVolumeRenderMultiResParams::viewport
+
+
+ +

+Single viewport representing the entire region to composite against. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_volume_render_params.html b/docs/api/files/struct_nv_flow_volume_render_params.html new file mode 100644 index 0000000..e29d037 --- /dev/null +++ b/docs/api/files/struct_nv_flow_volume_render_params.html @@ -0,0 +1,488 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowVolumeRenderParams Struct Reference + + + + + + + + +
+

NvFlowVolumeRenderParams Struct Reference
+ +[NvFlowVolumeRender] +

Parameters for Flow grid rendering. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields

bool colorCompositeOnly
 If true, only apply color composite.
bool debugMode
 If true, wireframe visualization is rendered.
float depthAlphaThreshold
 Minimum alpha to trigger depth write.
float depthIntensityThreshold
 Intensity on R or G or B to trigger depth write.
NvFlowDepthStencilView * depthStencilView
 Depth stencil view for depth testing with ray march.
NvFlowVolumeRenderDownsample downsampleFactor
 Controls size of ray marching render target relative to app render target.
bool generateDepth
 If true, generate nominal depth, and write to scene depth buffer.
bool generateDepthDebugMode
 If true, visualize depth estimate.
NvFlowVolumeRenderLMSParams lensMatchedShading
 Lens matched shading parameters.
NvFlowRenderMaterialPool * materialPool
 Pool of materials to look for matches to GridMaterials.
NvFlowFloat4x4 modelMatrix
 Model matrix, row major.
NvFlowVolumeRenderMultiResParams multiRes
 Multires parameters.
NvFlowMultiResRayMarch multiResRayMarch
 Coarsest downsample for multiple resolution ray march.
float multiResSamplingScale
 1.0 by default, increase for finer screen XY minimum sampling rate
bool preColorCompositeOnly
 If true, do all operations except color composite.
NvFlowFloat4x4 projectionMatrix
 Projection matrix, row major.
NvFlowGridTextureChannel renderChannel
 GridExport channel to render.
NvFlowVolumeRenderMode renderMode
 Render mode, see NvFlowVolumeRenderMode.
NvFlowRenderTargetView * renderTargetView
 Render target view to composite ray marched result against.
float screenPercentage
 If 1.0, render at full ray march resolution, can be dynamically reduced toward 0.0 to ray march at a lower resolution.
bool smoothColorUpsample
 If true, color upsample will do extra work to remove jaggies around depth discontinuities.
NvFlowFloat4x4 viewMatrix
 View matrix, row major.
+

Detailed Description

+Parameters for Flow grid rendering.

Field Documentation

+ +
+
+ + + + +
bool NvFlowVolumeRenderParams::colorCompositeOnly
+
+
+ +

+If true, only apply color composite. +

+ +

+

+ +

+
+ + + + +
bool NvFlowVolumeRenderParams::debugMode
+
+
+ +

+If true, wireframe visualization is rendered. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderParams::depthAlphaThreshold
+
+
+ +

+Minimum alpha to trigger depth write. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderParams::depthIntensityThreshold
+
+
+ +

+Intensity on R or G or B to trigger depth write. +

+ +

+

+ +

+
+ + + + +
NvFlowDepthStencilView* NvFlowVolumeRenderParams::depthStencilView
+
+
+ +

+Depth stencil view for depth testing with ray march. +

+ +

+

+ +

+
+ + + + +
NvFlowVolumeRenderDownsample NvFlowVolumeRenderParams::downsampleFactor
+
+
+ +

+Controls size of ray marching render target relative to app render target. +

+ +

+

+ +

+
+ + + + +
bool NvFlowVolumeRenderParams::generateDepth
+
+
+ +

+If true, generate nominal depth, and write to scene depth buffer. +

+ +

+

+ +

+
+ + + + +
bool NvFlowVolumeRenderParams::generateDepthDebugMode
+
+
+ +

+If true, visualize depth estimate. +

+ +

+

+ +

+
+ + + + +
NvFlowVolumeRenderLMSParams NvFlowVolumeRenderParams::lensMatchedShading
+
+
+ +

+Lens matched shading parameters. +

+ +

+

+ +

+
+ + + + +
NvFlowRenderMaterialPool* NvFlowVolumeRenderParams::materialPool
+
+
+ +

+Pool of materials to look for matches to GridMaterials. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4x4 NvFlowVolumeRenderParams::modelMatrix
+
+
+ +

+Model matrix, row major. +

+ +

+

+ +

+
+ + + + +
NvFlowVolumeRenderMultiResParams NvFlowVolumeRenderParams::multiRes
+
+
+ +

+Multires parameters. +

+ +

+

+ +

+
+ + + + +
NvFlowMultiResRayMarch NvFlowVolumeRenderParams::multiResRayMarch
+
+
+ +

+Coarsest downsample for multiple resolution ray march. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderParams::multiResSamplingScale
+
+
+ +

+1.0 by default, increase for finer screen XY minimum sampling rate +

+ +

+

+ +

+
+ + + + +
bool NvFlowVolumeRenderParams::preColorCompositeOnly
+
+
+ +

+If true, do all operations except color composite. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4x4 NvFlowVolumeRenderParams::projectionMatrix
+
+
+ +

+Projection matrix, row major. +

+ +

+

+ +

+
+ + + + +
NvFlowGridTextureChannel NvFlowVolumeRenderParams::renderChannel
+
+
+ +

+GridExport channel to render. +

+ +

+

+ +

+
+ + + + +
NvFlowVolumeRenderMode NvFlowVolumeRenderParams::renderMode
+
+
+ +

+Render mode, see NvFlowVolumeRenderMode. +

+ +

+

+ +

+
+ + + + +
NvFlowRenderTargetView* NvFlowVolumeRenderParams::renderTargetView
+
+
+ +

+Render target view to composite ray marched result against. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderParams::screenPercentage
+
+
+ +

+If 1.0, render at full ray march resolution, can be dynamically reduced toward 0.0 to ray march at a lower resolution. +

+ +

+

+ +

+
+ + + + +
bool NvFlowVolumeRenderParams::smoothColorUpsample
+
+
+ +

+If true, color upsample will do extra work to remove jaggies around depth discontinuities. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4x4 NvFlowVolumeRenderParams::viewMatrix
+
+
+ +

+View matrix, row major. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_volume_render_viewport.html b/docs/api/files/struct_nv_flow_volume_render_viewport.html new file mode 100644 index 0000000..52528df --- /dev/null +++ b/docs/api/files/struct_nv_flow_volume_render_viewport.html @@ -0,0 +1,116 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowVolumeRenderViewport Struct Reference + + + + + + + + +
+

NvFlowVolumeRenderViewport Struct Reference
+ +[NvFlowVolumeRender] +

Rendering viewport. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + +

Data Fields

float height
float topLeftX
float topLeftY
float width
+

Detailed Description

+Rendering viewport.

Field Documentation

+ +
+
+ + + + +
float NvFlowVolumeRenderViewport::height
+
+
+ +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderViewport::topLeftX
+
+
+ +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderViewport::topLeftY
+
+
+ +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeRenderViewport::width
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_volume_shadow_debug_render_params.html b/docs/api/files/struct_nv_flow_volume_shadow_debug_render_params.html new file mode 100644 index 0000000..b8c4990 --- /dev/null +++ b/docs/api/files/struct_nv_flow_volume_shadow_debug_render_params.html @@ -0,0 +1,108 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowVolumeShadowDebugRenderParams Struct Reference + + + + + + + + +
+

NvFlowVolumeShadowDebugRenderParams Struct Reference
+ +[NvFlowVolumeShadow] +

Parameters required to visualize shadow block allocation. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + +

Data Fields

NvFlowFloat4x4 projectionMatrix
 Render target projection matrix, row major.
NvFlowRenderTargetView * renderTargetView
 Render target to draw visualization to.
NvFlowFloat4x4 viewMatrix
 Render target view matrix, row major.
+

Detailed Description

+Parameters required to visualize shadow block allocation.

Field Documentation

+ +
+
+ + + + +
NvFlowFloat4x4 NvFlowVolumeShadowDebugRenderParams::projectionMatrix
+
+
+ +

+Render target projection matrix, row major. +

+ +

+

+ +

+
+ + + + +
NvFlowRenderTargetView* NvFlowVolumeShadowDebugRenderParams::renderTargetView
+
+
+ +

+Render target to draw visualization to. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4x4 NvFlowVolumeShadowDebugRenderParams::viewMatrix
+
+
+ +

+Render target view matrix, row major. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_volume_shadow_desc.html b/docs/api/files/struct_nv_flow_volume_shadow_desc.html new file mode 100644 index 0000000..3195d09 --- /dev/null +++ b/docs/api/files/struct_nv_flow_volume_shadow_desc.html @@ -0,0 +1,168 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowVolumeShadowDesc Struct Reference + + + + + + + + +
+

NvFlowVolumeShadowDesc Struct Reference
+ +[NvFlowVolumeShadow] +

Description required to create volume shadow object. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + + + + +

Data Fields

NvFlowGridExport * gridExport
 Grid export for memory allocation.
NvFlowUint mapDepth
 Virtual depth of shadow voxel address space.
NvFlowUint mapHeight
 Virtual height of shadow voxel address space.
NvFlowUint mapWidth
 Virtual width of shadow voxel address space.
float maxResidentScale
 Maximum fraction of virtual cells to allocate memory for.
float minResidentScale
 Minimum (and initial) fraction of virtual cells to allocate memory for.
+

Detailed Description

+Description required to create volume shadow object.

Field Documentation

+ +
+
+ + + + +
NvFlowGridExport* NvFlowVolumeShadowDesc::gridExport
+
+
+ +

+Grid export for memory allocation. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowVolumeShadowDesc::mapDepth
+
+
+ +

+Virtual depth of shadow voxel address space. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowVolumeShadowDesc::mapHeight
+
+
+ +

+Virtual height of shadow voxel address space. +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowVolumeShadowDesc::mapWidth
+
+
+ +

+Virtual width of shadow voxel address space. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeShadowDesc::maxResidentScale
+
+
+ +

+Maximum fraction of virtual cells to allocate memory for. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeShadowDesc::minResidentScale
+
+
+ +

+Minimum (and initial) fraction of virtual cells to allocate memory for. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_volume_shadow_params.html b/docs/api/files/struct_nv_flow_volume_shadow_params.html new file mode 100644 index 0000000..7db48ad --- /dev/null +++ b/docs/api/files/struct_nv_flow_volume_shadow_params.html @@ -0,0 +1,228 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowVolumeShadowParams Struct Reference + + + + + + + + +
+

NvFlowVolumeShadowParams Struct Reference
+ +[NvFlowVolumeShadow] +

Parameters required to update volume shadows. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields

float intensityScale
 Shadow intensity scale.
NvFlowRenderMaterialPool * materialPool
 Pool of materials to look for matches to GridMaterials.
float minIntensity
 Minimum shadow intensity.
NvFlowFloat4x4 projectionMatrix
 Projection matrix, row major.
NvFlowGridTextureChannel renderChannel
 GridExport channel to render.
NvFlowVolumeRenderMode renderMode
 Render mode, see NvFlowVolumeRenderMode.
float shadowBlendBias
 Bias on shadow blend factor.
NvFlowFloat4 shadowBlendCompMask
 Component mask to control which channel(s) modulate the shadow blending.
NvFlowFloat4x4 viewMatrix
 View matrix, row major.
+

Detailed Description

+Parameters required to update volume shadows.

Field Documentation

+ +
+
+ + + + +
float NvFlowVolumeShadowParams::intensityScale
+
+
+ +

+Shadow intensity scale. +

+ +

+

+ +

+
+ + + + +
NvFlowRenderMaterialPool* NvFlowVolumeShadowParams::materialPool
+
+
+ +

+Pool of materials to look for matches to GridMaterials. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeShadowParams::minIntensity
+
+
+ +

+Minimum shadow intensity. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4x4 NvFlowVolumeShadowParams::projectionMatrix
+
+
+ +

+Projection matrix, row major. +

+ +

+

+ +

+
+ + + + +
NvFlowGridTextureChannel NvFlowVolumeShadowParams::renderChannel
+
+
+ +

+GridExport channel to render. +

+ +

+

+ +

+
+ + + + +
NvFlowVolumeRenderMode NvFlowVolumeShadowParams::renderMode
+
+
+ +

+Render mode, see NvFlowVolumeRenderMode. +

+ +

+

+ +

+
+ + + + +
float NvFlowVolumeShadowParams::shadowBlendBias
+
+
+ +

+Bias on shadow blend factor. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4 NvFlowVolumeShadowParams::shadowBlendCompMask
+
+
+ +

+Component mask to control which channel(s) modulate the shadow blending. +

+ +

+

+ +

+
+ + + + +
NvFlowFloat4x4 NvFlowVolumeShadowParams::viewMatrix
+
+
+ +

+View matrix, row major. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/struct_nv_flow_volume_shadow_stats.html b/docs/api/files/struct_nv_flow_volume_shadow_stats.html new file mode 100644 index 0000000..60f43ff --- /dev/null +++ b/docs/api/files/struct_nv_flow_volume_shadow_stats.html @@ -0,0 +1,99 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowVolumeShadowStats Struct Reference + + + + + + + + +
+

NvFlowVolumeShadowStats Struct Reference
+ +[NvFlowVolumeShadow] +

Stats on currently active volume shadow. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + +

Data Fields

NvFlowUint shadowBlocksActive
NvFlowUint shadowCellsActive
NvFlowUint shadowColumnsActive
+

Detailed Description

+Stats on currently active volume shadow.

Field Documentation

+ +
+
+ + + + +
NvFlowUint NvFlowVolumeShadowStats::shadowBlocksActive
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowVolumeShadowStats::shadowCellsActive
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowUint NvFlowVolumeShadowStats::shadowColumnsActive
+
+
+ +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/files/tab_b.gif b/docs/api/files/tab_b.gif new file mode 100644 index 0000000..0d62348 Binary files /dev/null and b/docs/api/files/tab_b.gif differ diff --git a/docs/api/files/tab_l.gif b/docs/api/files/tab_l.gif new file mode 100644 index 0000000..9b1e633 Binary files /dev/null and b/docs/api/files/tab_l.gif differ diff --git a/docs/api/files/tab_r.gif b/docs/api/files/tab_r.gif new file mode 100644 index 0000000..ce9dd9f Binary files /dev/null and b/docs/api/files/tab_r.gif differ diff --git a/docs/api/files/tabs.css b/docs/api/files/tabs.css new file mode 100644 index 0000000..ab02c62 --- /dev/null +++ b/docs/api/files/tabs.css @@ -0,0 +1,105 @@ +/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ + +DIV.tabs +{ + float : left; + width : 100%; + background : url("tab_b.gif") repeat-x bottom; + margin-bottom : 4px; +} + +DIV.tabs UL +{ + margin : 0px; + padding-left : 10px; + list-style : none; +} + +DIV.tabs LI, DIV.tabs FORM +{ + display : inline; + margin : 0px; + padding : 0px; +} + +DIV.tabs FORM +{ + float : right; +} + +DIV.tabs A +{ + float : left; + background : url("tab_r.gif") no-repeat right top; + border-bottom : 1px solid #84B0C7; + font-size : 80%; + font-weight : bold; + text-decoration : none; +} + +DIV.tabs A:hover +{ + background-position: 100% -150px; +} + +DIV.tabs A:link, DIV.tabs A:visited, +DIV.tabs A:active, DIV.tabs A:hover +{ + color: #1A419D; +} + +DIV.tabs SPAN +{ + float : left; + display : block; + background : url("tab_l.gif") no-repeat left top; + padding : 5px 9px; + white-space : nowrap; +} + +DIV.tabs INPUT +{ + float : right; + display : inline; + font-size : 1em; +} + +DIV.tabs TD +{ + font-size : 80%; + font-weight : bold; + text-decoration : none; +} + + + +/* Commented Backslash Hack hides rule from IE5-Mac \*/ +DIV.tabs SPAN {float : none;} +/* End IE5-Mac hack */ + +DIV.tabs A:hover SPAN +{ + background-position: 0% -150px; +} + +DIV.tabs LI.current A +{ + background-position: 100% -150px; + border-width : 0px; +} + +DIV.tabs LI.current SPAN +{ + background-position: 0% -150px; + padding-bottom : 6px; +} + +DIV.navpath +{ + background : none; + border : none; + border-bottom : 1px solid #84B0C7; + text-align : center; + margin : 2px; + padding : 2px; +} diff --git a/docs/api/files/tree.html b/docs/api/files/tree.html new file mode 100644 index 0000000..9d4db48 --- /dev/null +++ b/docs/api/files/tree.html @@ -0,0 +1,579 @@ + + + + + + + TreeView + + + + +
+

NVIDIA(R) Flow(R) 1.0.0 API Reference

+
+

o+Modules

+
+

|o+NvFlowGrid

+ +

|o+NvFlowGridMaterial

+ +

|o+NvFlowShape

+ +

|o+NvFlowGridEmit

+ +

|o+NvFlowGridEmitCustom

+ +

|o+NvFlowGridExport

+ +

|o+NvFlowGridImport

+ +

|o+NvFlowRenderMaterial

+ +

|o+NvFlowVolumeRender

+ +

|o+NvFlowVolumeShadow

+ +

|o+NvFlowCrossSection

+ +

|o+NvFlowGridProxy

+ +

|o+NvFlowDevice

+ +

|o+NvFlowSDFGenerator

+ +

|o+NvFlowParticleSurface

+ +

|o+NvFlowContext

+ +

|o+NvFlowContextD3D11

+ +

|\+NvFlowContextD3D12

+ +
+

o+Data Structures

+
+

|o*NvFlowColorMapData

+

|o*NvFlowContextDescD3D11

+

|o*NvFlowContextDescD3D12

+

|o*NvFlowCrossSectionDesc

+

|o*NvFlowCrossSectionParams

+

|o*NvFlowDepthStencilViewDescD3D11

+

|o*NvFlowDepthStencilViewDescD3D12

+

|o*NvFlowDescriptorReserveHandleD3D12

+

|o*NvFlowDeviceDesc

+

|o*NvFlowDeviceQueueDesc

+

|o*NvFlowDeviceQueueStatus

+

|o*NvFlowDim

+

|o*NvFlowDynamicDescriptorHeapD3D12

+

|o*NvFlowFloat3

+

|o*NvFlowFloat4

+

|o*NvFlowFloat4x4

+

|o*NvFlowGridDesc

+

|o*NvFlowGridEmitCustomAllocParams

+

|o*NvFlowGridEmitCustomEmitLayerParams

+

|o*NvFlowGridEmitCustomEmitParams

+

|o*NvFlowGridEmitParams

+

|o*NvFlowGridExportDebugVisView

+

|o*NvFlowGridExportHandle

+

|o*NvFlowGridExportImportLayeredMapping

+

|o*NvFlowGridExportImportLayerMapping

+

|o*NvFlowGridExportLayeredView

+

|o*NvFlowGridExportLayerView

+

|o*NvFlowGridExportSimpleShape

+

|o*NvFlowGridImportDesc

+

|o*NvFlowGridImportHandle

+

|o*NvFlowGridImportLayeredView

+

|o*NvFlowGridImportLayerView

+

|o*NvFlowGridImportParams

+

|o*NvFlowGridImportStateCPUParams

+

|o*NvFlowGridMaterialHandle

+

|o*NvFlowGridMaterialParams

+

|o*NvFlowGridMaterialPerComponent

+

|o*NvFlowGridParams

+

|o*NvFlowGridProxyDesc

+

|o*NvFlowGridProxyFlushParams

+

|o*NvFlowGridResetDesc

+

|o*NvFlowParticleSurfaceData

+

|o*NvFlowParticleSurfaceDesc

+

|o*NvFlowParticleSurfaceEmitParams

+

|o*NvFlowParticleSurfaceParams

+

|o*NvFlowQueryTime

+

|o*NvFlowRenderMaterialHandle

+

|o*NvFlowRenderMaterialParams

+

|o*NvFlowRenderMaterialPoolDesc

+

|o*NvFlowRenderTargetViewDescD3D11

+

|o*NvFlowRenderTargetViewDescD3D12

+

|o*NvFlowResourceRWViewDescD3D11

+

|o*NvFlowResourceRWViewDescD3D12

+

|o*NvFlowResourceViewDescD3D11

+

|o*NvFlowResourceViewDescD3D12

+

|o*NvFlowSDFGenDesc

+

|o*NvFlowSDFGenMeshParams

+

|o*NvFlowShaderLinearParams

+

|o*NvFlowShaderPointParams

+

|o*NvFlowShapeDesc

+

|o*NvFlowShapeDescBox

+

|o*NvFlowShapeDescCapsule

+

|o*NvFlowShapeDescPlane

+

|o*NvFlowShapeDescSDF

+

|o*NvFlowShapeDescSphere

+

|o*NvFlowShapeSDFData

+

|o*NvFlowShapeSDFDesc

+

|o*NvFlowSupport

+

|o*NvFlowUint2

+

|o*NvFlowUint3

+

|o*NvFlowUint4

+

|o*NvFlowVolumeLightingParams

+

|o*NvFlowVolumeRenderDesc

+

|o*NvFlowVolumeRenderLMSParams

+

|o*NvFlowVolumeRenderMultiResParams

+

|o*NvFlowVolumeRenderParams

+

|o*NvFlowVolumeRenderViewport

+

|o*NvFlowVolumeShadowDebugRenderParams

+

|o*NvFlowVolumeShadowDesc

+

|o*NvFlowVolumeShadowParams

+

|\*NvFlowVolumeShadowStats

+
+

o*Data Fields

+

o+File List

+ +

\*Globals

+
+
+ diff --git a/docs/api/files/union_nv_flow_shape_desc.html b/docs/api/files/union_nv_flow_shape_desc.html new file mode 100644 index 0000000..5fbf45b --- /dev/null +++ b/docs/api/files/union_nv_flow_shape_desc.html @@ -0,0 +1,133 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowShapeDesc Union Reference + + + + + + + + +
+

NvFlowShapeDesc Union Reference
+ +[NvFlowShape] +

Shared type for shape descriptions. +More... +

+#include <NvFlow.h> +

+ + + + + + + + + + + + + +

Data Fields

NvFlowShapeDescBox box
NvFlowShapeDescCapsule capsule
NvFlowShapeDescPlane plane
NvFlowShapeDescSDF sdf
NvFlowShapeDescSphere sphere
+

Detailed Description

+Shared type for shape descriptions.

Field Documentation

+ +
+
+ + + + +
NvFlowShapeDescBox NvFlowShapeDesc::box
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowShapeDescCapsule NvFlowShapeDesc::capsule
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowShapeDescPlane NvFlowShapeDesc::plane
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowShapeDescSDF NvFlowShapeDesc::sdf
+
+
+ +

+ +

+

+ +

+
+ + + + +
NvFlowShapeDescSphere NvFlowShapeDesc::sphere
+
+
+ +

+ +

+

+

The documentation for this union was generated from the following file: +
+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + diff --git a/docs/api/index.html b/docs/api/index.html new file mode 100644 index 0000000..8799d0a --- /dev/null +++ b/docs/api/index.html @@ -0,0 +1,4 @@ + + + + -- cgit v1.2.3