API Reference

The infinigen2 package.

Subpackages

• Shaders (.shaders)
  • Subpackages
    • Base Materials (.shaders.base_materials)
      • brick_concrete
      • carpet
      • ceramic
      • concrete
      • emissive_nonblocking
      • fabric
      • glass_colored
      • glass_no_refraction
      • granite
      • gravel_concrete
      • marble
      • metal_brushed
      • metal_hammered
      • paint
      • plastic
      • stone_smooth
      • terrazzo
      • wood_grain
      • Module contents
    • Composite Materials (.shaders.composites)
      • bricks
      • fabric_patterned
      • paint_overlay
      • scratches_overlay
      • splats_overlay
      • tiles
      • wood_planks
      • Module contents
    • Masks (.shaders.masks)
      • brick_cutter
      • brick_selector
      • cracks
      • edgewear
      • scratches
      • splats
      • tile_shapes
      • Module contents
    • Displacements (.shaders.displacements)
      • chip_noise
      • masonry
      • Module contents
    • Shader Utilities (.shaders.util)
      • coord
      • mix
      • Module contents
  • dev
    • bsdf_simple_rand()
    • developer_grid()
    • flat_bsdf()
  • functionality_lists
    • art_color_rand()
    • art_pattern_material_rand()
    • ceiling_material_rand()
    • floor_material_rand()
    • furniture_fabric()
    • furniture_material_rand()
    • glass_material_rand()
    • mirror_material_rand()
    • paint_flaked_rand()
    • paint_wall_rand()
    • rug_material_rand()
    • skirt_material_rand()
    • table_top_material_rand()
    • uv_maybe_rotate()
    • uv_maybe_rotate_90()
    • wall_material_rand()
  • Module contents
• Objects (.objects)
  • bookcase
    • BookcaseResult
      • BookcaseResult.mesh
    • bookcase()
    • bookcase_rand()
  • cabinet
    • CabinetResult
      • CabinetResult.mesh
    • cabinet()
    • cabinet_rand()
  • ceiling_light
    • CeilingLightResult
      • CeilingLightResult.mesh
      • CeilingLightResult.light
    • black_for_reflections()
    • ceiling_light()
    • ceiling_light_rand()
  • desk
    • DeskResult
      • DeskResult.mesh
    • desk()
    • desk_rand()
  • dev
    • banana()
  • drawers
    • DrawersResult
      • DrawersResult.mesh
    • drawers()
    • drawers_rand()
  • flower
    • FlowerMaterials
      • FlowerMaterials.petal
      • FlowerMaterials.center
    • FlowerResult
      • FlowerResult.mesh
    • center_material()
    • flower()
    • flower_rand()
  • lamp
    • LampResult
      • LampResult.mesh
      • LampResult.light
    • desk_lamp_rand()
    • point_light_indoor()
    • point_light_indoor_rand()
    • lamp()
    • lamp_rand()
    • lampshade_color_rand()
    • lampshade_fabric_rand()
  • random_primitives
    • PrimitivesResult
      • PrimitivesResult.mesh
    • all_materials_rand()
    • primitives_rand()
  • rug
    • RugResult
      • RugResult.mesh
    • rug()
    • rug_rand()
  • slot_cabinet
    • SlotCabinetResult
      • SlotCabinetResult.mesh
    • metric_box_uv()
    • shelf()
    • slot_cabinet_rand()
  • sofa
    • SofaResult
      • SofaResult.mesh
    • sofa()
    • sofa_rand()
  • table
    • TableResult
      • TableResult.mesh
    • base_single_stand()
    • base_single_stand_rand()
    • base_square()
    • base_square_rand()
    • base_straight()
    • base_straight_rand()
    • cocktail_table_rand()
    • coffee_table_rand()
    • dining_table_rand()
    • side_table_dimensions_rand()
    • side_table_rand()
    • table_dimensions_rand()
    • table_top()
  • triangle_shelf
    • TriangleShelfResult
      • TriangleShelfResult.mesh
    • triangle_shelf()
    • triangle_shelf_rand()
  • vase
    • VaseResult
      • VaseResult.mesh
    • vase()
    • vase_material_rand()
    • vase_rand()
  • wall_art
    • WallArtResult
      • WallArtResult.mesh
    • art_frame()
    • mirror_rand()
    • mirror_surface_material_rand()
    • wall_art_rand()
  • window
    • CurtainResult
      • CurtainResult.mesh
    • WindowResult
      • WindowResult.mesh
      • WindowResult.light
    • curtain()
    • curtain_rand()
    • window()
    • window_dimensions_rand()
    • window_rand()
  • Module contents
• Scenes (.scenes)
  • Rooms (.scenes.room)
    • room
      • LivingroomResult
      • livingroom_rand()
    • room_furniture
      • ArrangementResult
      • MeshResult
      • RoomFurnitureResult
      • back_face_grounded()
      • centered_sofa_setup_rand()
      • keep_unobstructed()
      • place_dining_table()
      • random_bbox_poses_animation_rand()
      • retry_place()
      • room_furniture_rand()
      • side_table_object_rand()
      • storage_object_rand()
      • table_decoration_object_rand()
    • room_shape
      • RoomEdgeToWallsResult
      • RoomShapeResult
      • room_dimensions_rand()
      • room_edge_to_walls()
      • room_shape_rand()
    • room_small_objects
      • objects_scatter_rand()
      • objects_scattered_on_surface()
      • small_objects_collection_rand()
    • room_surface_features
      • CeilingFeaturesResult
      • WallFeatureResult
      • WallFeaturesResult
      • ceiling_feature_rand()
      • ceiling_light_bars_rand()
      • ceiling_light_placement_rand()
      • ceiling_skylights_rand()
      • cutout_spaced_instances()
      • skirting_on_walls_rand()
      • skirting_rand()
      • upright_cabinet_footprint()
      • wall_board_shelf_rand()
      • wall_cubby_rand()
      • wall_decoration_rand()
      • wall_doors_rand()
      • wall_feature_rand()
      • wall_full_window_rand()
      • wall_horizontal_split_rand()
      • wall_painting_grid_rand()
      • wall_plain_rand()
      • wall_storage_flush_rand()
      • wall_storage_shelf_rand()
      • wall_vertical_split_rand()
      • wall_window_extrusion_rand()
      • wall_windows_rand()
      • window_spaced_rand()
    • Module contents
  • asset_demo
    • DevSceneResult
      • DevSceneResult.all_objects
      • DevSceneResult.cameras
      • DevSceneResult.lights
    • demo_cube()
    • grid_plane()
    • hardcoded_camera()
    • material_banana()
    • material_cube()
    • material_monkey()
    • material_plane_horizontal_uv()
    • material_plane_orthographic()
    • material_plane_uv()
    • material_sphere()
    • material_torus_uv()
    • object_demo()
    • scale_reference()
  • collision_collection
    • CollisionSet
    • any_self_collision()
    • box_intersection_test()
    • collision_set()
    • intersection_test()
    • n_colliders()
    • raycast()
  • floating_objects
    • FloatingObjectsResult
      • FloatingObjectsResult.all_objects
      • FloatingObjectsResult.colliders
    • floating_lights_rand()
    • floating_object_asset_rand()
    • floating_objects_rand()
    • point_lamp_colored_rand()
    • rotated_bbox_extents()
  • placement_utils
    • delete_object()
    • distribute_in_bbox()
    • duplicates()
    • keep_non_colliding()
    • repeat_attempts()
    • snap_to_plane()
  • Module contents
• Animations (.animations)
  • random_walk
    • RandomWalkSampler
      • RandomWalkSampler.margin
      • RandomWalkSampler.speed_mps_range
      • RandomWalkSampler.loc_step_range
      • RandomWalkSampler.rot_std_deg
      • RandomWalkSampler.roll_range_deg
      • RandomWalkSampler.pitch_range_deg
      • RandomWalkSampler.height_range
      • RandomWalkSampler.loc_bias
    • walk_loop()
  • Module contents
• Cameras (.cameras)
  • framing
    • camera_with_distance_framing_object()
  • monocular
    • linear_pan_camera_rand()
    • material_orbit_camera_rand()
    • monocular_360_camera_rand()
    • monocular_camera_in_bbox_rand()
    • orbit_90_camera_rand()
  • random_walk
    • random_walk_camera()
  • rrt
    • RRTPolicyError
    • rrt_camera()
    • rrt_camera_fast()
  • stereo
    • stereo_camera_rig_rand()
    • stereo_cameras_in_bbox_rand()
    • stereo_random_walk_camera()
  • util
    • attach_stereo_right()
    • camera_collision_check()
    • pose_and_filter()
    • total_bbox()
  • Module contents
    • camera_with_distance_framing_object()
    • stereo_cameras_in_bbox_rand()
    • stereo_random_walk_camera()
    • monocular_camera_in_bbox_rand()
    • monocular_360_camera_rand()
    • linear_pan_camera_rand()
    • orbit_90_camera_rand()
    • material_orbit_camera_rand()
    • random_walk_camera()
    • rrt_camera()
    • rrt_camera_fast()
    • camera_collision_check()
    • total_bbox()
• Curves (.curves)
  • room_edge
    • RoomEdgeCurveResult
      • RoomEdgeCurveResult.curve
      • RoomEdgeCurveResult.is_flat_point
      • RoomEdgeCurveResult.orig_point_idx
    • rectangle_outline()
    • room_edge_curve_rand()
  • skirting_board_profile
    • skirting_profile()
    • skirting_profile_rand()
  • Module contents
• Exporters (.exporters)
  • Exporter Utilities (.exporters.util)
    • blender_render
      • DisplacementMode
      • ViewLayerPass
      • configure_compositor_viewlayer_output()
      • configure_material_index_table()
      • configure_object_index_table()
      • load_single_channel()
      • override_shading_for_gt()
      • postprocess_renderpass_frame()
      • postprocess_renderpass_paths()
    • eevee_aov
      • configure_materials_for_aovs()
      • setup_eevee_aovs()
    • export_utils
      • load_exr()
    • flow_vis
      • flow_to_color()
      • flow_uv_to_colors()
      • make_colorwheel()
    • format
      • Compression
      • ExportType
      • RenderPass
      • ensure_path_placeholders()
    • Module contents
  • imu
    • get_camera_intrinsics()
    • save_imu()
    • save_imu_tum_files()
  • render_cycles
    • DenoiseMode
      • DenoiseMode.NONE
      • DenoiseMode.BEST
      • DenoiseMode.OPTIX
      • DenoiseMode.OPENIMAGEDENOISE
    • configure_cycles_devices()
    • configure_cycles_performance()
    • render_cycles()
    • render_cycles_ground_truth()
  • render_eevee
    • RenderEeveeParams
      • RenderEeveeParams.taa_render_samples
      • RenderEeveeParams.use_taa_reprojection
      • RenderEeveeParams.film_exposure
      • RenderEeveeParams.taa_samples
      • RenderEeveeParams.use_gtao
      • RenderEeveeParams.gtao_distance
      • RenderEeveeParams.gtao_quality
      • RenderEeveeParams.use_shadows
      • RenderEeveeParams.shadow_pool_size
      • RenderEeveeParams.shadow_ray_count
      • RenderEeveeParams.shadow_resolution_scale
      • RenderEeveeParams.shadow_step_count
      • RenderEeveeParams.use_raytracing
      • RenderEeveeParams.ray_tracing_method
      • RenderEeveeParams.use_fast_gi
      • RenderEeveeParams.fast_gi_method
      • RenderEeveeParams.fast_gi_ray_count
      • RenderEeveeParams.fast_gi_resolution
      • RenderEeveeParams.fast_gi_step_count
      • RenderEeveeParams.fast_gi_quality
      • RenderEeveeParams.fast_gi_bias
      • RenderEeveeParams.fast_gi_distance
      • RenderEeveeParams.fast_gi_thickness_far
      • RenderEeveeParams.fast_gi_thickness_near
      • RenderEeveeParams.use_overscan
      • RenderEeveeParams.overscan_size
      • RenderEeveeParams.use_volume_custom_range
      • RenderEeveeParams.volumetric_start
      • RenderEeveeParams.volumetric_end
      • RenderEeveeParams.volumetric_samples
      • RenderEeveeParams.volumetric_shadow_samples
      • RenderEeveeParams.volumetric_tile_size
      • RenderEeveeParams.volumetric_sample_rand
      • RenderEeveeParams.volumetric_light_clamp
      • RenderEeveeParams.volumetric_ray_depth
      • RenderEeveeParams.use_volumetric_shadows
    • configure_eevee_params()
    • render_eevee()
    • render_eevee_ground_truth()
  • render_error_check
    • CyclesShaderError
    • DisplacementCoordError
    • ShaderTooComplexError
    • UVCoordError
    • UVLayerInfo
      • UVLayerInfo.active_render
      • UVLayerInfo.names
      • UVLayerInfo.degenerate
    • assert_displacement_coords_safe()
    • assert_shader_complexity_ok()
    • assert_uv_coords_satisfied()
    • check_material_uv_coords()
    • count_material_nodes()
    • detect_cycles_errors()
    • render_validity_check()
    • unsafe_displacement_materials()
  • render_workbench
    • render_workbench()
  • visualize_gt
    • load_data()
    • load_single_channel()
    • mask_to_transparency_checkerboard()
    • visualize_any_frametype()
    • visualize_bw()
    • visualize_depth()
    • visualize_flow()
    • visualize_gt()
    • visualize_normals()
    • visualize_seg_mask()
    • visualize_uniq_inst()
  • Module contents
• Lighting (.lighting)
  • point_lighting
    • ColoredLightsResult
      • ColoredLightsResult.environment
      • ColoredLightsResult.lights
    • floating_colored_lights_rand()
    • point_lamp_colored_rand()
  • sky_lighting
    • EnvironmentResult
      • EnvironmentResult.environment
      • EnvironmentResult.lights
    • hosek_wilkie_sky()
    • hosek_wilkie_sky_rand()
    • hosek_wilkie_sky_with_sun_lamp_rand()
    • nishita_sky()
    • nishita_sky_rand()
    • sky_with_sun_lamp_rand()
  • Module contents
• Utilities (.util)
  • Code Statistics (.util.codestats)
    • compute
      • shannon_entropy_bits()
      • cyclomatic_complexity()
      • solve_tree()
      • solve_dp()
    • setup
      • build_model_from_compute_graph()
      • build_indexed_model()
      • compute_stats()
    • Module contents
      • build_indexed_model()
      • build_model_from_compute_graph()
      • compute_stats()
      • cyclomatic_complexity()
      • solve_dp()
      • solve_tree()
  • camera_projection
    • adjust_camera_sensor()
    • bpy_resolution()
    • get_calibration_matrix_K_from_blender()
    • get_3x4_RT_matrix_from_blender()
    • get_3x4_P_matrix_from_blender()
    • project_points()
    • is_projection_within_image()
    • camera_depth_raycast()
    • get_camera_parameters()
  • curve
    • CurveToMeshWithUvResult
      • CurveToMeshWithUvResult.mesh
      • CurveToMeshWithUvResult.vector
    • FilletMaskResult
      • FilletMaskResult.curve
      • FilletMaskResult.is_fillet_point
      • FilletMaskResult.is_flat_point
      • FilletMaskResult.orig_point_idx
    • curve_to_mesh_with_uv()
    • curve_to_noncyclic()
    • fillet_mask()
  • errors
    • RejectedScene
  • external_assets
    • distribution_from_asset_glob()
    • pregenerated_asset_rand()
  • hardware_info
    • get_hardware_info()
  • import_utils
    • module_path()
  • instance
    • instance()
    • instanced_objects()
  • math
    • offset_spacing()
  • mesh
    • CubeWithVertexIndicesResult
      • CubeWithVertexIndicesResult.mesh
      • CubeWithVertexIndicesResult.index_x
      • CubeWithVertexIndicesResult.index_y
      • CubeWithVertexIndicesResult.index_z
    • ExtrudeSeamlessResult
      • ExtrudeSeamlessResult.mesh
      • ExtrudeSeamlessResult.top
      • ExtrudeSeamlessResult.side
    • WallCutoutResult
      • WallCutoutResult.wall
      • WallCutoutResult.sill
      • WallCutoutResult.lightblocker
    • corner_box()
    • crease_sharp()
    • extrude_mesh_seamless_uvs()
    • grid_from_corners()
    • uv_winding_sign()
    • wall_cutout_split()
  • render_metadata
    • time_step()
    • write_render_metadata()
  • scene_cleanup
    • cleanup_except()
  • Module contents
• UV Surface (.uv_surface)
  • grid_placement
    • FacesForInstanceGridBboxesResult
      • FacesForInstanceGridBboxesResult.mesh
      • FacesForInstanceGridBboxesResult.is_instance_face
    • GridFromSpacingResult
      • GridFromSpacingResult.grid_mesh
      • GridFromSpacingResult.query_uv
      • GridFromSpacingResult.index_x
      • GridFromSpacingResult.index_y
    • GridWithIndicesResult
      • GridWithIndicesResult.mesh
      • GridWithIndicesResult.index_x
      • GridWithIndicesResult.index_y
      • GridWithIndicesResult.uv_integer
      • GridWithIndicesResult.uv_factor
    • NormedUvToBoundsUvResult
      • NormedUvToBoundsUvResult.uv_out
      • NormedUvToBoundsUvResult.lower
      • NormedUvToBoundsUvResult.upper
    • SubgridResult
      • SubgridResult.is_boundary
      • SubgridResult.is_boundary_x
      • SubgridResult.is_boundary_y
      • SubgridResult.subgrid_verts_x
      • SubgridResult.subgrid_verts_y
      • SubgridResult.subgrid_index_x
      • SubgridResult.subgrid_index_y
    • faces_for_instance_grid_bboxes()
    • grid_from_spacing()
    • grid_with_indices()
    • normed_uv_to_bounds_uv()
    • place_instances_on_uv_grid()
    • subgrid()
  • Module contents

infinigen2.generate

infinigen2.generate.get_parser()

Get the argument parser for the infinigen2 generate command.

infinigen2.generate.execute_generators(

...,

) → dict[ExportType, list[Path]]

Parameters:

• output_folder (Path)

• generators (list[tuple[str, str, Callable]])

• rng (Generator)

• pipeline_parameters (dict)

infinigen2.generate.resolve_pass_argument(export_type) → RenderPass | None

Parameters:

export_type (ExportType)

infinigen2.generate.main()

infinigen2.graph_json

Serialize a ComputeGraph to a human-readable JSON format.

infinigen2.graph_json.to_json(graph, indent=2) → str

Parameters:

• graph (ComputeGraph)

• indent (int) -- (default: 2)

infinigen2.list

infinigen2.list.get_parser()

infinigen2.list.preset_dotted_names() → list[str]

Dotted names of every preset the manifest declares, resolved in its owning generator’s module (presets live alongside the generator that owns them).

infinigen2.list.preset_parents() → dict[str, str]

Map each preset shortname to the generator shortname that owns it, read directly from the manifest presets lists (no name-based inference).

infinigen2.list.main()

Module contents

infinigen2.module_path()