search

pyglet / pyglet

pyglet is a cross-platform windowing and multimedia library for Python, for developing games and other visually rich applications.
http://pyglet.org
BSD 3-Clause "New" or "Revised" License
1.85k stars 302 forks source link

Why is changing the content of Labels taking so long? #678

Closed eschan145 closed 6 months ago

eschan145 commented 2 years ago

So I'm making an FPS display using a pyglet label, and I notice that with profiling, the label takes eats up all of my time. The text is changed every frame to match the latest framerate, and that causes pyglet to really lag.

The pyglet.text.Label class subclasses DocumentLabel, which subclasses TextLayout. From reading the docs, I know that any TextLayouts are not suitable for changing text frequently. Could we make another layout class that enables us to do such a thing?

benmoran56 commented 2 years ago

There is a window.FPSDisplay class that you might want to look at.

As for your frame rate issue, could you post some example code?

eschan145 commented 2 years ago

Just draw a label, change its text every frame, and run a profiler check. You will see that most of the time is taken for changing the text.

einarf commented 2 years ago

What version are you using? From dev22 and later this was optimized pretty heavily.

eschan145 commented 2 years ago

I'm using modified versions of Arcade Text objects drawn with pyglet rendering. They are pyglet.text.HTMLLabels BTW. Using the latest pyglet and arcade from Github.

In the HTMLLabel code, I noticed when changing the text, the HTML text needs to be decoded every time.

einarf commented 2 years ago

Did you try with dev22 or latest master? Still don't know what pyglet version you are using.

eschan145 commented 2 years ago

Latest pyglet. Probably it lags because I make decode new HTML documents every time.

eschan145 commented 2 years ago

Could we make a system to only calculate the vertex points of the new text, and keep the old vertex points? This would probably save performance.

caffeinepills commented 2 years ago

That's not really viable as each character in a string has different width, and advance requirements, especially with HTML as even bolded can change the width. So re-using vertex placements can't realistically be done IMO.

It's possible it could be something in the HTML decoder, but will need to see an example and how much performance loss you are seeing. Unless you are updating a ton of labels simultaneously with paragraphs of characters (which requires lots of formatting and glyph creation), I don't think it would be much of an issue. I haven't run into this issue myself using dozens of small labels at once. If you are scheduling updating of text values, I would make sure to put a reasonable rate on it or only update the labels when changes are actually made.

Hard to say what the issue is without an example of code and a printout of the pyglet information. (python -m pyglet.info)

eschan145 commented 2 years ago

Here's my pyglet info. It's pretty long.

Platform
------------------------------------------------------------------------------
platform:  Windows-10-10.0.22000-SP0
release:   10
machine:   AMD64

Python
------------------------------------------------------------------------------
implementation: CPython
sys.version: 3.10.0 (tags/v3.10.0:b494f59, Oct  4 2021, 19:00:18) [MSC v.1929 64 bit (AMD64)]
sys.maxint: 9223372036854775807
os.getcwd(): C:\Users\esamu

pyglet
------------------------------------------------------------------------------
pyglet.version: 2.0.dev22
pyglet.compat_platform: win32
pyglet.__file__: C:\Users\esamu\AppData\Local\Programs\Python\Python310\lib\site-packages\pyglet\__init__.py
pyglet.options['audio'] = ('xaudio2', 'directsound', 'openal', 'pulse', 'silent')
pyglet.options['debug_font'] = False
pyglet.options['debug_gl'] = True
pyglet.options['debug_gl_trace'] = False
pyglet.options['debug_gl_trace_args'] = False
pyglet.options['debug_gl_shaders'] = False
pyglet.options['debug_graphics_batch'] = False
pyglet.options['debug_lib'] = False
pyglet.options['debug_media'] = False
pyglet.options['debug_texture'] = False
pyglet.options['debug_trace'] = False
pyglet.options['debug_trace_args'] = False
pyglet.options['debug_trace_depth'] = 1
pyglet.options['debug_trace_flush'] = True
pyglet.options['debug_win32'] = False
pyglet.options['debug_input'] = False
pyglet.options['debug_x11'] = False
pyglet.options['shadow_window'] = True
pyglet.options['vsync'] = None
pyglet.options['xsync'] = True
pyglet.options['xlib_fullscreen_override_redirect'] = False
pyglet.options['search_local_libs'] = True
pyglet.options['win32_gdi_font'] = False
pyglet.options['headless'] = False
pyglet.options['headless_device'] = 0
pyglet.options['win32_disable_shaping'] = False
pyglet.options['xinput_controllers'] = True

pyglet.window
------------------------------------------------------------------------------
display: <pyglet.canvas.win32.Win32Display object at 0x000001D70488BC40>
screens[0]: Win32Screen(x=-1920, y=0, width=1920, height=1080)
screens[1]: Win32Screen(x=0, y=0, width=1920, height=1080)
config['double_buffer'] = 1
config['stereo'] = 0
config['buffer_size'] = 32
config['aux_buffers'] = 4
config['sample_buffers'] = 0
config['samples'] = 0
config['red_size'] = 8
config['green_size'] = 8
config['blue_size'] = 8
config['alpha_size'] = 0
config['depth_size'] = 24
config['stencil_size'] = 0
config['accum_red_size'] = 16
config['accum_green_size'] = 16
config['accum_blue_size'] = 16
config['accum_alpha_size'] = 16
config['major_version'] = 3
config['minor_version'] = 3
config['forward_compatible'] = None
config['opengl_api'] = None
config['debug'] = None
context: Win32ARBContext(id=2022999410192, share=Win32Context(id=2023005997088, share=None))

window.context._info
------------------------------------------------------------------------------
gl_info.get_version(): (3, 3)
gl_info.get_vendor(): NVIDIA Corporation
gl_info.get_renderer(): RTX A2000 Laptop GPU/PCIe/SSE2
gl_info.get_extensions():
   GL_AMD_multi_draw_indirect
   GL_AMD_seamless_cubemap_per_texture
   GL_AMD_vertex_shader_layer
   GL_AMD_vertex_shader_viewport_index
   GL_ARB_ES2_compatibility
   GL_ARB_ES3_1_compatibility
   GL_ARB_ES3_2_compatibility
   GL_ARB_ES3_compatibility
   GL_ARB_arrays_of_arrays
   GL_ARB_base_instance
   GL_ARB_bindless_texture
   GL_ARB_blend_func_extended
   GL_ARB_buffer_storage
   GL_ARB_cl_event
   GL_ARB_clear_buffer_object
   GL_ARB_clear_texture
   GL_ARB_clip_control
   GL_ARB_color_buffer_float
   GL_ARB_compressed_texture_pixel_storage
   GL_ARB_compute_shader
   GL_ARB_compute_variable_group_size
   GL_ARB_conditional_render_inverted
   GL_ARB_conservative_depth
   GL_ARB_copy_buffer
   GL_ARB_copy_image
   GL_ARB_cull_distance
   GL_ARB_debug_output
   GL_ARB_depth_buffer_float
   GL_ARB_depth_clamp
   GL_ARB_depth_texture
   GL_ARB_derivative_control
   GL_ARB_direct_state_access
   GL_ARB_draw_buffers
   GL_ARB_draw_buffers_blend
   GL_ARB_draw_elements_base_vertex
   GL_ARB_draw_indirect
   GL_ARB_draw_instanced
   GL_ARB_enhanced_layouts
   GL_ARB_explicit_attrib_location
   GL_ARB_explicit_uniform_location
   GL_ARB_fragment_coord_conventions
   GL_ARB_fragment_layer_viewport
   GL_ARB_fragment_program
   GL_ARB_fragment_program_shadow
   GL_ARB_fragment_shader
   GL_ARB_fragment_shader_interlock
   GL_ARB_framebuffer_no_attachments
   GL_ARB_framebuffer_object
   GL_ARB_framebuffer_sRGB
   GL_ARB_geometry_shader4
   GL_ARB_get_program_binary
   GL_ARB_get_texture_sub_image
   GL_ARB_gl_spirv
   GL_ARB_gpu_shader5
   GL_ARB_gpu_shader_fp64
   GL_ARB_gpu_shader_int64
   GL_ARB_half_float_pixel
   GL_ARB_half_float_vertex
   GL_ARB_imaging
   GL_ARB_indirect_parameters
   GL_ARB_instanced_arrays
   GL_ARB_internalformat_query
   GL_ARB_internalformat_query2
   GL_ARB_invalidate_subdata
   GL_ARB_map_buffer_alignment
   GL_ARB_map_buffer_range
   GL_ARB_multi_bind
   GL_ARB_multi_draw_indirect
   GL_ARB_multisample
   GL_ARB_multitexture
   GL_ARB_occlusion_query
   GL_ARB_occlusion_query2
   GL_ARB_parallel_shader_compile
   GL_ARB_pipeline_statistics_query
   GL_ARB_pixel_buffer_object
   GL_ARB_point_parameters
   GL_ARB_point_sprite
   GL_ARB_polygon_offset_clamp
   GL_ARB_post_depth_coverage
   GL_ARB_program_interface_query
   GL_ARB_provoking_vertex
   GL_ARB_query_buffer_object
   GL_ARB_robust_buffer_access_behavior
   GL_ARB_robustness
   GL_ARB_sample_locations
   GL_ARB_sample_shading
   GL_ARB_sampler_objects
   GL_ARB_seamless_cube_map
   GL_ARB_seamless_cubemap_per_texture
   GL_ARB_separate_shader_objects
   GL_ARB_shader_atomic_counter_ops
   GL_ARB_shader_atomic_counters
   GL_ARB_shader_ballot
   GL_ARB_shader_bit_encoding
   GL_ARB_shader_clock
   GL_ARB_shader_draw_parameters
   GL_ARB_shader_group_vote
   GL_ARB_shader_image_load_store
   GL_ARB_shader_image_size
   GL_ARB_shader_objects
   GL_ARB_shader_precision
   GL_ARB_shader_storage_buffer_object
   GL_ARB_shader_subroutine
   GL_ARB_shader_texture_image_samples
   GL_ARB_shader_texture_lod
   GL_ARB_shader_viewport_layer_array
   GL_ARB_shading_language_100
   GL_ARB_shading_language_420pack
   GL_ARB_shading_language_include
   GL_ARB_shading_language_packing
   GL_ARB_shadow
   GL_ARB_sparse_buffer
   GL_ARB_sparse_texture
   GL_ARB_sparse_texture2
   GL_ARB_sparse_texture_clamp
   GL_ARB_spirv_extensions
   GL_ARB_stencil_texturing
   GL_ARB_sync
   GL_ARB_tessellation_shader
   GL_ARB_texture_barrier
   GL_ARB_texture_border_clamp
   GL_ARB_texture_buffer_object
   GL_ARB_texture_buffer_object_rgb32
   GL_ARB_texture_buffer_range
   GL_ARB_texture_compression
   GL_ARB_texture_compression_bptc
   GL_ARB_texture_compression_rgtc
   GL_ARB_texture_cube_map
   GL_ARB_texture_cube_map_array
   GL_ARB_texture_env_add
   GL_ARB_texture_env_combine
   GL_ARB_texture_env_crossbar
   GL_ARB_texture_env_dot3
   GL_ARB_texture_filter_anisotropic
   GL_ARB_texture_filter_minmax
   GL_ARB_texture_float
   GL_ARB_texture_gather
   GL_ARB_texture_mirror_clamp_to_edge
   GL_ARB_texture_mirrored_repeat
   GL_ARB_texture_multisample
   GL_ARB_texture_non_power_of_two
   GL_ARB_texture_query_levels
   GL_ARB_texture_query_lod
   GL_ARB_texture_rectangle
   GL_ARB_texture_rg
   GL_ARB_texture_rgb10_a2ui
   GL_ARB_texture_stencil8
   GL_ARB_texture_storage
   GL_ARB_texture_storage_multisample
   GL_ARB_texture_swizzle
   GL_ARB_texture_view
   GL_ARB_timer_query
   GL_ARB_transform_feedback2
   GL_ARB_transform_feedback3
   GL_ARB_transform_feedback_instanced
   GL_ARB_transform_feedback_overflow_query
   GL_ARB_transpose_matrix
   GL_ARB_uniform_buffer_object
   GL_ARB_vertex_array_bgra
   GL_ARB_vertex_array_object
   GL_ARB_vertex_attrib_64bit
   GL_ARB_vertex_attrib_binding
   GL_ARB_vertex_buffer_object
   GL_ARB_vertex_program
   GL_ARB_vertex_shader
   GL_ARB_vertex_type_10f_11f_11f_rev
   GL_ARB_vertex_type_2_10_10_10_rev
   GL_ARB_viewport_array
   GL_ARB_window_pos
   GL_ATI_draw_buffers
   GL_ATI_texture_float
   GL_ATI_texture_mirror_once
   GL_EXTX_framebuffer_mixed_formats
   GL_EXT_Cg_shader
   GL_EXT_abgr
   GL_EXT_bgra
   GL_EXT_bindable_uniform
   GL_EXT_blend_color
   GL_EXT_blend_equation_separate
   GL_EXT_blend_func_separate
   GL_EXT_blend_minmax
   GL_EXT_blend_subtract
   GL_EXT_compiled_vertex_array
   GL_EXT_depth_bounds_test
   GL_EXT_direct_state_access
   GL_EXT_draw_buffers2
   GL_EXT_draw_instanced
   GL_EXT_draw_range_elements
   GL_EXT_fog_coord
   GL_EXT_framebuffer_blit
   GL_EXT_framebuffer_multisample
   GL_EXT_framebuffer_multisample_blit_scaled
   GL_EXT_framebuffer_object
   GL_EXT_framebuffer_sRGB
   GL_EXT_geometry_shader4
   GL_EXT_gpu_program_parameters
   GL_EXT_gpu_shader4
   GL_EXT_import_sync_object
   GL_EXT_memory_object
   GL_EXT_memory_object_win32
   GL_EXT_multi_draw_arrays
   GL_EXT_multiview_tessellation_geometry_shader
   GL_EXT_multiview_texture_multisample
   GL_EXT_multiview_timer_query
   GL_EXT_packed_depth_stencil
   GL_EXT_packed_float
   GL_EXT_packed_pixels
   GL_EXT_pixel_buffer_object
   GL_EXT_point_parameters
   GL_EXT_polygon_offset_clamp
   GL_EXT_post_depth_coverage
   GL_EXT_provoking_vertex
   GL_EXT_raster_multisample
   GL_EXT_rescale_normal
   GL_EXT_secondary_color
   GL_EXT_semaphore
   GL_EXT_semaphore_win32
   GL_EXT_separate_shader_objects
   GL_EXT_separate_specular_color
   GL_EXT_shader_image_load_formatted
   GL_EXT_shader_image_load_store
   GL_EXT_shader_integer_mix
   GL_EXT_shadow_funcs
   GL_EXT_sparse_texture2
   GL_EXT_stencil_two_side
   GL_EXT_stencil_wrap
   GL_EXT_texture3D
   GL_EXT_texture_array
   GL_EXT_texture_buffer_object
   GL_EXT_texture_compression_dxt1
   GL_EXT_texture_compression_latc
   GL_EXT_texture_compression_rgtc
   GL_EXT_texture_compression_s3tc
   GL_EXT_texture_cube_map
   GL_EXT_texture_edge_clamp
   GL_EXT_texture_env_add
   GL_EXT_texture_env_combine
   GL_EXT_texture_env_dot3
   GL_EXT_texture_filter_anisotropic
   GL_EXT_texture_filter_minmax
   GL_EXT_texture_integer
   GL_EXT_texture_lod
   GL_EXT_texture_lod_bias
   GL_EXT_texture_mirror_clamp
   GL_EXT_texture_object
   GL_EXT_texture_sRGB
   GL_EXT_texture_sRGB_R8
   GL_EXT_texture_sRGB_decode
   GL_EXT_texture_shadow_lod
   GL_EXT_texture_shared_exponent
   GL_EXT_texture_storage
   GL_EXT_texture_swizzle
   GL_EXT_timer_query
   GL_EXT_transform_feedback2
   GL_EXT_vertex_array
   GL_EXT_vertex_array_bgra
   GL_EXT_vertex_attrib_64bit
   GL_EXT_win32_keyed_mutex
   GL_EXT_window_rectangles
   GL_IBM_rasterpos_clip
   GL_IBM_texture_mirrored_repeat
   GL_KHR_blend_equation_advanced
   GL_KHR_blend_equation_advanced_coherent
   GL_KHR_context_flush_control
   GL_KHR_debug
   GL_KHR_no_error
   GL_KHR_parallel_shader_compile
   GL_KHR_robust_buffer_access_behavior
   GL_KHR_robustness
   GL_KHR_shader_subgroup
   GL_KTX_buffer_region
   GL_NVX_blend_equation_advanced_multi_draw_buffers
   GL_NVX_conditional_render
   GL_NVX_gpu_memory_info
   GL_NVX_gpu_multicast2
   GL_NVX_linked_gpu_multicast
   GL_NVX_multigpu_info
   GL_NVX_nvenc_interop
   GL_NVX_progress_fence
   GL_NV_ES1_1_compatibility
   GL_NV_ES3_1_compatibility
   GL_NV_alpha_to_coverage_dither_control
   GL_NV_bindless_multi_draw_indirect
   GL_NV_bindless_multi_draw_indirect_count
   GL_NV_bindless_texture
   GL_NV_blend_equation_advanced
   GL_NV_blend_equation_advanced_coherent
   GL_NV_blend_minmax_factor
   GL_NV_blend_square
   GL_NV_clip_space_w_scaling
   GL_NV_command_list
   GL_NV_compute_program5
   GL_NV_compute_shader_derivatives
   GL_NV_conditional_render
   GL_NV_conservative_raster
   GL_NV_conservative_raster_dilate
   GL_NV_conservative_raster_pre_snap
   GL_NV_conservative_raster_pre_snap_triangles
   GL_NV_conservative_raster_underestimation
   GL_NV_copy_depth_to_color
   GL_NV_copy_image
   GL_NV_deep_texture3D
   GL_NV_depth_buffer_float
   GL_NV_depth_clamp
   GL_NV_draw_texture
   GL_NV_draw_vulkan_image
   GL_NV_explicit_multisample
   GL_NV_feature_query
   GL_NV_fence
   GL_NV_fill_rectangle
   GL_NV_float_buffer
   GL_NV_fog_distance
   GL_NV_fragment_coverage_to_color
   GL_NV_fragment_program
   GL_NV_fragment_program2
   GL_NV_fragment_program_option
   GL_NV_fragment_shader_barycentric
   GL_NV_fragment_shader_interlock
   GL_NV_framebuffer_mixed_samples
   GL_NV_framebuffer_multisample_coverage
   GL_NV_geometry_shader4
   GL_NV_geometry_shader_passthrough
   GL_NV_gpu_multicast
   GL_NV_gpu_program4
   GL_NV_gpu_program4_1
   GL_NV_gpu_program5
   GL_NV_gpu_program5_mem_extended
   GL_NV_gpu_program_fp64
   GL_NV_gpu_shader5
   GL_NV_half_float
   GL_NV_internalformat_sample_query
   GL_NV_light_max_exponent
   GL_NV_memory_attachment
   GL_NV_memory_object_sparse
   GL_NV_mesh_shader
   GL_NV_multisample_coverage
   GL_NV_multisample_filter_hint
   GL_NV_occlusion_query
   GL_NV_packed_depth_stencil
   GL_NV_parameter_buffer_object
   GL_NV_parameter_buffer_object2
   GL_NV_path_rendering
   GL_NV_path_rendering_shared_edge
   GL_NV_pixel_data_range
   GL_NV_point_sprite
   GL_NV_primitive_restart
   GL_NV_primitive_shading_rate
   GL_NV_query_resource
   GL_NV_query_resource_tag
   GL_NV_register_combiners
   GL_NV_register_combiners2
   GL_NV_representative_fragment_test
   GL_NV_sample_locations
   GL_NV_sample_mask_override_coverage
   GL_NV_scissor_exclusive
   GL_NV_shader_atomic_counters
   GL_NV_shader_atomic_float
   GL_NV_shader_atomic_float64
   GL_NV_shader_atomic_fp16_vector
   GL_NV_shader_atomic_int64
   GL_NV_shader_buffer_load
   GL_NV_shader_storage_buffer_object
   GL_NV_shader_subgroup_partitioned
   GL_NV_shader_texture_footprint
   GL_NV_shader_thread_group
   GL_NV_shader_thread_shuffle
   GL_NV_shading_rate_image
   GL_NV_stereo_view_rendering
   GL_NV_texgen_reflection
   GL_NV_texture_barrier
   GL_NV_texture_compression_vtc
   GL_NV_texture_dirty_tile_map
   GL_NV_texture_env_combine4
   GL_NV_texture_multisample
   GL_NV_texture_rectangle
   GL_NV_texture_rectangle_compressed
   GL_NV_texture_shader
   GL_NV_texture_shader2
   GL_NV_texture_shader3
   GL_NV_timeline_semaphore
   GL_NV_transform_feedback
   GL_NV_transform_feedback2
   GL_NV_uniform_buffer_unified_memory
   GL_NV_vertex_array_range
   GL_NV_vertex_array_range2
   GL_NV_vertex_attrib_integer_64bit
   GL_NV_vertex_buffer_unified_memory
   GL_NV_vertex_program
   GL_NV_vertex_program1_1
   GL_NV_vertex_program2
   GL_NV_vertex_program2_option
   GL_NV_vertex_program3
   GL_NV_viewport_array2
   GL_NV_viewport_swizzle
   GL_OVR_multiview
   GL_OVR_multiview2
   GL_S3_s3tc
   GL_SGIS_generate_mipmap
   GL_SGIS_texture_lod
   GL_SGIX_depth_texture
   GL_SGIX_shadow
   GL_SUN_slice_accum
   GL_WIN_swap_hint
   WGL_EXT_swap_control

pyglet.gl.glx_info
------------------------------------------------------------------------------
GLX not available.

pyglet.media
------------------------------------------------------------------------------
audio driver: <pyglet.media.drivers.xaudio2.adaptation.XAudio2Driver object at 0x000001D70275FCD0>

pyglet.media.ffmpeg
------------------------------------------------------------------------------
FFmpeg not available.

pyglet.media.drivers.openal
------------------------------------------------------------------------------
OpenAL not available.

pyglet.input.wintab
------------------------------------------------------------------------------
WinTab not available.
eschan145 commented 2 years ago

I will provide some source code soon.

benmoran56 commented 1 year ago

Hi, do you still need help with this? Decoding HTML content each frame would cause it. It's quite expensive, and only meant to be done at load time.

eschan145 commented 1 year ago

Yes, its causing some small (but very noticeable) lag.

shenjackyuanjie commented 1 year ago

Hi! would you like to view my code? I also write some FPS label using sepreate compute and display you can see it at fps_log and render part you can try it by copy a few line into anther file PS: it looks like this image (these "200" is 700) @eschan145

eschan145 commented 1 year ago

Ok, I took a look. What do you want me to do?

You can use pyglet.clock.get_frequency() to get the current fps. It's faster than trying to do it yourself.

@shenjackyuanjie

caffeinepills commented 6 months ago

Closing as user never provided example. There have been many text performance improvements since. Feel free to open a new issue with examples using the latest version.